class Symbol
一个 Symbol 对象代表 Ruby 解释器内的命名标识符。
你可以显式地使用
在程序执行期间，对于给定的名称或字符串，将创建同一个 Symbol 对象，而与该名称的上下文或含义无关。因此，如果 Fred 在一种上下文中是一个常量，在另一种上下文中是一个方法，在第三种上下文中是一个类，那么 Symbol :Fred 在这三种上下文中将是同一个对象。
module One class Fred end $f1 = :Fred end module Two Fred = 1 $f2 = :Fred end def Fred() end $f3 = :Fred $f1.object_id #=> 2514190 $f2.object_id #=> 2514190 $f3.object_id #=> 2514190
常量、方法和变量名将作为符号返回
module One Two = 2 def three; 3 end @four = 4 @@five = 5 $six = 6 end seven = 7 One.constants # => [:Two] One.instance_methods(true) # => [:three] One.instance_variables # => [:@four] One.class_variables # => [:@@five] global_variables.grep(/six/) # => [:$six] local_variables # => [:seven]
一个 Symbol 对象与 String 对象不同之处在于，Symbol 对象代表一个标识符，而 String 对象代表文本或数据。
这里有什么
首先，其他地方是什么。Class Symbol
-
继承自 Object 类。
这里，class Symbol 提供了对有用的方法，用于
查询方法
-
::all_symbols: 返回一个数组，包含 Ruby 当前符号表中的所有符号。 -
empty?: 如果self.length为零，则返回true；否则返回false。 -
end_with?: 如果符号以任何给定的字符串结尾，则返回true。 -
start_with?: 如果符号以任何给定的字符串开头，则返回true。
比较方法
-
<=>: 如果给定符号小于、等于或大于符号，则分别返回 -1、0 或 1。 -
casecmp: 忽略大小写，如果给定符号小于、等于或大于符号，则分别返回 -1、0 或 1。 -
casecmp?: 如果符号在 Unicode 大小写折叠后与给定符号相等，则返回true；否则返回false。
转换方法
Public Class Methods
Source
static VALUE
sym_all_symbols(VALUE _)
{
return rb_sym_all_symbols();
}
返回一个数组，包含 Ruby 当前符号表中的所有符号。
Symbol.all_symbols.size # => 9334 Symbol.all_symbols.take(3) # => [:!, :"\"", :"#"]
Source
# File ext/json/lib/json/add/symbol.rb, line 49 def self.json_create(o) o['s'].to_sym end
参见 as_json。
Public Instance Methods
Source
static VALUE
sym_cmp(VALUE sym, VALUE other)
{
if (!SYMBOL_P(other)) {
return Qnil;
}
return rb_str_cmp_m(rb_sym2str(sym), rb_sym2str(other));
}
比较 self 和 other，使用 String#<=>。
返回
-
如果
other是一个符号，则为self.to_s <=> other.to_s。 -
nil，否则。
示例
:bar <=> :foo # => -1 :foo <=> :foo # => 0 :foo <=> :bar # => 1 :foo <=> 'bar' # => nil
Class Symbol 包含模块 Comparable，其每个方法都使用 Symbol#<=> 进行比较。
相关：String#<=>。
Source
static VALUE
sym_match(VALUE sym, VALUE other)
{
return rb_str_match(rb_sym2str(sym), other);
}
等同于 symbol.to_s =~ object，包括对全局变量的可能更新；请参阅 String#=~。
Source
static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}
等同于 symbol.to_s[]；请参阅 String#[]。
Source
# File ext/json/lib/json/add/symbol.rb, line 23 def as_json(*) { JSON.create_id => self.class.name, 's' => to_s, } end
方法 Symbol#as_json 和 Symbol.json_create 可用于序列化和反序列化 Symbol 对象；请参阅 Marshal。
方法 Symbol#as_json 序列化 self，返回一个表示 self 的 2 元素哈希。
require 'json/add/symbol' x = :foo.as_json # => {"json_class"=>"Symbol", "s"=>"foo"}
方法 JSON.create 反序列化这样的哈希，返回一个 Symbol 对象。
Symbol.json_create(x) # => :foo
Source
static VALUE
sym_capitalize(int argc, VALUE *argv, VALUE sym)
{
return rb_str_intern(rb_str_capitalize(argc, argv, rb_sym2str(sym)));
}
等同于 sym.to_s.capitalize.to_sym。
Source
static VALUE
sym_casecmp(VALUE sym, VALUE other)
{
if (!SYMBOL_P(other)) {
return Qnil;
}
return str_casecmp(rb_sym2str(sym), rb_sym2str(other));
}
类似于 Symbol#<=>，但忽略大小写；等同于 self.to_s.casecmp(object.to_s)。
lower = :abc upper = :ABC upper.casecmp(lower) # => 0 lower.casecmp(lower) # => 0 lower.casecmp(upper) # => 0
如果 self 和 object 的编码不兼容，或者 object 不是符号，则返回 nil。
sym = 'äöü'.encode("ISO-8859-1").to_sym other_sym = 'ÄÖÜ' sym.casecmp(other_sym) # => nil :foo.casecmp(2) # => nil
与 Symbol#casecmp? 不同，大小写不敏感仅对 ‘A’..‘Z’ 和 ‘a’..‘z’ 之间的字符有效。
lower = :äöü upper = :ÄÖÜ upper.casecmp(lower) # => -1 lower.casecmp(lower) # => 0 lower.casecmp(upper) # => 1
Source
static VALUE
sym_casecmp_p(VALUE sym, VALUE other)
{
if (!SYMBOL_P(other)) {
return Qnil;
}
return str_casecmp_p(rb_sym2str(sym), rb_sym2str(other));
}
如果 self 和 object 在 Unicode 大小写折叠后相等，则返回 true，否则返回 false。
lower = :abc upper = :ABC upper.casecmp?(lower) # => true lower.casecmp?(lower) # => true lower.casecmp?(upper) # => true
如果 self 和 object 的编码不兼容，或者 object 不是符号，则返回 nil。
sym = 'äöü'.encode("ISO-8859-1").to_sym other_sym = 'ÄÖÜ' sym.casecmp?(other_sym) # => nil :foo.casecmp?(2) # => nil
与 Symbol#casecmp 不同，它对 ‘A’..‘Z’ 和 ‘a’..‘z’ 之外的字符也有效。
lower = :äöü upper = :ÄÖÜ upper.casecmp?(lower) # => true lower.casecmp?(lower) # => true lower.casecmp?(upper) # => true
Source
static VALUE
sym_downcase(int argc, VALUE *argv, VALUE sym)
{
return rb_str_intern(rb_str_downcase(argc, argv, rb_sym2str(sym)));
}
Source
static VALUE
sym_empty(VALUE sym)
{
return rb_str_empty(rb_sym2str(sym));
}
如果 self 是 :''，则返回 true，否则返回 false。
Source
static VALUE
sym_encoding(VALUE sym)
{
return rb_obj_encoding(rb_sym2str(sym));
}
等同于 self.to_s.encoding；请参阅 String#encoding。
Source
static VALUE
sym_end_with(int argc, VALUE *argv, VALUE sym)
{
return rb_str_end_with(argc, argv, rb_sym2str(sym));
}
等同于 self.to_s.end_with?；请参阅 String#end_with?。
Source
static VALUE
sym_inspect(VALUE sym)
{
VALUE str = rb_sym2str(sym);
const char *ptr;
long len;
char *dest;
if (!rb_str_symname_p(str)) {
str = rb_str_inspect(str);
len = RSTRING_LEN(str);
rb_str_resize(str, len + 1);
dest = RSTRING_PTR(str);
memmove(dest + 1, dest, len);
}
else {
rb_encoding *enc = STR_ENC_GET(str);
VALUE orig_str = str;
len = RSTRING_LEN(orig_str);
str = rb_enc_str_new(0, len + 1, enc);
// Get data pointer after allocation
ptr = RSTRING_PTR(orig_str);
dest = RSTRING_PTR(str);
memcpy(dest + 1, ptr, len);
RB_GC_GUARD(orig_str);
}
dest[0] = ':';
RUBY_ASSERT_BUILTIN_TYPE(str, T_STRING);
return str;
}
Source
static VALUE
sym_length(VALUE sym)
{
return rb_str_length(rb_sym2str(sym));
}
等同于 self.to_s.length；请参阅 String#length。
Source
static VALUE
sym_match_m(int argc, VALUE *argv, VALUE sym)
{
return rb_str_match_m(argc, argv, rb_sym2str(sym));
}
等同于 self.to_s.match，包括对全局变量的可能更新；请参阅 String#match。
Source
static VALUE
sym_match_m_p(int argc, VALUE *argv, VALUE sym)
{
return rb_str_match_m_p(argc, argv, sym);
}
等同于 sym.to_s.match?；请参阅 String#match。
Source
# File symbol.rb, line 26 def name Primitive.attr! :leaf Primitive.cexpr! 'rb_sym2str(self)' end
返回 self 的冻结字符串表示（不包括前导冒号）。
:foo.name # => "foo" :foo.name.frozen? # => true
Source
static VALUE
sym_start_with(int argc, VALUE *argv, VALUE sym)
{
return rb_str_start_with(argc, argv, rb_sym2str(sym));
}
等同于 self.to_s.start_with?；请参阅 String#start_with?。
Source
static VALUE
sym_succ(VALUE sym)
{
return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}
Source
static VALUE
sym_swapcase(int argc, VALUE *argv, VALUE sym)
{
return rb_str_intern(rb_str_swapcase(argc, argv, rb_sym2str(sym)));
}
等同于 sym.to_s.swapcase.to_sym。
参见 String#swapcase。
Source
# File ext/json/lib/json/add/symbol.rb, line 39 def to_json(state = nil, *a) state = ::JSON::State.from_state(state) if state.strict? super else as_json.to_json(state, *a) end end
返回一个代表 self 的 JSON 字符串
require 'json/add/symbol' puts :foo.to_json
输出
# {"json_class":"Symbol","s":"foo"}
Source
VALUE
rb_sym_to_proc(VALUE sym)
{
enum {SYM_PROC_CACHE_SIZE = 67};
if (rb_ractor_main_p()) {
if (!sym_proc_cache) {
sym_proc_cache = rb_ary_hidden_new(SYM_PROC_CACHE_SIZE);
rb_ary_store(sym_proc_cache, SYM_PROC_CACHE_SIZE - 1, Qnil);
}
ID id = SYM2ID(sym);
long index = (id % SYM_PROC_CACHE_SIZE);
VALUE procval = RARRAY_AREF(sym_proc_cache, index);
if (RTEST(procval)) {
rb_proc_t *proc;
GetProcPtr(procval, proc);
if (proc->block.as.symbol == sym) {
return procval;
}
}
procval = sym_proc_new(rb_cProc, sym);
RARRAY_ASET(sym_proc_cache, index, procval);
return RB_GC_GUARD(procval);
}
else {
return sym_proc_new(rb_cProc, sym);
}
}
返回一个 Proc 对象，该对象将在第一个参数上调用以 self 为名的该方法，并将剩余参数传递给该方法。
proc = :to_s.to_proc # => #<Proc:0x000001afe0e48680(&:to_s) (lambda)> proc.call(1000) # => "1000" proc.call(1000, 16) # => "3e8" (1..3).collect(&:to_s) # => ["1", "2", "3"]
Source
# File symbol.rb, line 10 def to_s Primitive.attr! :leaf Primitive.cexpr! 'rb_sym_to_s(self)' end
Source
static VALUE
sym_upcase(int argc, VALUE *argv, VALUE sym)
{
return rb_str_intern(rb_str_upcase(argc, argv, rb_sym2str(sym)));
}
等同于 sym.to_s.upcase.to_sym。
参见 String#upcase。