类 Symbol

Symbol 对象代表 Ruby 解释器中的命名标识符。

您可以使用以下方法显式创建 Symbol 对象：

对于给定的名称或字符串，在程序执行期间将创建相同的 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 对象代表文本或数据。

内容 ↑

首先，看看其他地方。类 Symbol

这里，类 Symbol 提供了对以下内容有用的方法：

查询方法 ↑

比较方法 ↑

转换方法 ↑

公共类方法

all_symbols → 符号数组 点击切换源代码

返回当前 Ruby 符号表中的所有符号数组。

Symbol.all_symbols.size    # => 9334
Symbol.all_symbols.take(3) # => [:!, :"\"", :"#"]

static VALUE
sym_all_symbols(VALUE _)
{
    return rb_sym_all_symbols();
}
json_create(o) 点击切换源代码

参见 as_json.

# File ext/json/lib/json/add/symbol.rb, line 45
def self.json_create(o)
  o['s'].to_sym
end

公共实例方法

symbol <=> object → -1, 0, +1 或 nil 点击切换源代码

如果 object 是一个符号，则返回等效于 symbol.to_s <=> object.to_s 的值。

:bar <=> :foo # => -1
:foo <=> :foo # => 0
:foo <=> :bar # => 1

否则，返回 nil。

:foo <=> 'bar' # => nil

相关：String#<=>.

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));
}
symbol == object → true 或 false 点击切换源代码

如果 object 与 self 是同一个对象，则返回 true，否则返回 false。

#define sym_equal rb_obj_equal
也称为：===
===
别名：==
symbol =~ object → 整数或 nil 点击切换源代码

等效于 symbol.to_s =~ object，包括对全局变量的可能更新；参见 String#=~.

static VALUE
sym_match(VALUE sym, VALUE other)
{
    return rb_str_match(rb_sym2str(sym), other);
}
symbol[index] → 字符串或 nil 点击切换源代码
symbol[start, length] → 字符串或 nil
symbol[range] → 字符串或 nil
symbol[regexp, capture = 0] → 字符串或 nil
symbol[substring] → 字符串或 nil

等效于 symbol.to_s[]；参见 String#[].

static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}
也称为：slice
as_json(*) 点击切换源代码

方法 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

# File ext/json/lib/json/add/symbol.rb, line 24
def as_json(*)
  {
    JSON.create_id => self.class.name,
    's'            => to_s,
  }
end
capitalize(*options) → symbol 点击切换源代码

等效于 sym.to_s.capitalize.to_sym。

参见 String#capitalize.

static VALUE
sym_capitalize(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_intern(rb_str_capitalize(argc, argv, rb_sym2str(sym)));
}
casecmp(object) → -1, 0, 1 或 nil 点击切换源代码

类似于 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

相关：Symbol#casecmp?，String#casecmp。

static VALUE
sym_casecmp(VALUE sym, VALUE other)
{
    if (!SYMBOL_P(other)) {
        return Qnil;
    }
    return str_casecmp(rb_sym2str(sym), rb_sym2str(other));
}
casecmp?(object) → true, false, 或 nil 点击切换源代码

如果 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

相关：Symbol#casecmp，String#casecmp?。

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));
}
downcase(*options) → symbol 点击切换源代码

等效于 sym.to_s.downcase.to_sym。

参见 String#downcase。

相关：Symbol#upcase。

static VALUE
sym_downcase(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_intern(rb_str_downcase(argc, argv, rb_sym2str(sym)));
}
empty? → true 或 false 点击切换源代码

如果 self 是 :''，则返回 true，否则返回 false。

static VALUE
sym_empty(VALUE sym)
{
    return rb_str_empty(rb_sym2str(sym));
}
encoding → encoding 点击切换源代码

等效于 self.to_s.encoding；参见 String#encoding。

static VALUE
sym_encoding(VALUE sym)
{
    return rb_obj_encoding(rb_sym2str(sym));
}
end_with?(*strings) → true 或 false 点击切换源代码

等效于 self.to_s.end_with?；参见 String#end_with?。

static VALUE
sym_end_with(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_end_with(argc, argv, rb_sym2str(sym));
}
id2name
别名：to_s
inspect → string 点击切换源代码

返回 self 的字符串表示形式（包括前导冒号）。

:foo.inspect # => ":foo"

相关：Symbol#to_s，Symbol#name。

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;
        RSTRING_GETMEM(orig_str, ptr, len);

        str = rb_enc_str_new(0, len + 1, enc);
        dest = RSTRING_PTR(str);
        memcpy(dest + 1, ptr, len);

        RB_GC_GUARD(orig_str);
    }
    dest[0] = ':';
    return str;
}
intern
别名：to_sym
length → integer 点击切换源代码

等效于 self.to_s.length；参见 String#length。

static VALUE
sym_length(VALUE sym)
{
    return rb_str_length(rb_sym2str(sym));
}
也称为：size
match(pattern, offset = 0) → matchdata 或 nil 点击切换源代码
match(pattern, offset = 0) {|matchdata| } → object

等效于 self.to_s.match，包括对全局变量的可能更新；参见 String#match。

static VALUE
sym_match_m(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m(argc, argv, rb_sym2str(sym));
}
match?(pattern, offset) → true 或 false 点击切换源代码

等效于 sym.to_s.match?；参见 String#match。

static VALUE
sym_match_m_p(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m_p(argc, argv, sym);
}
name → string 点击切换源代码

返回 self 的冻结字符串表示形式（不包括前导冒号）。

:foo.name         # => "foo"
:foo.name.frozen? # => true

相关：Symbol#to_s，Symbol#inspect。

VALUE
rb_sym2str(VALUE sym)
{
    if (DYNAMIC_SYM_P(sym)) {
        return RSYMBOL(sym)->fstr;
    }
    else {
        return rb_id2str(STATIC_SYM2ID(sym));
    }
}
succ

等效于 self.to_s.succ.to_sym

:foo.succ # => :fop

相关：String#succ.

别名：succ
size
别名：length
slice
别名：[]
start_with?(*string_or_regexp) → true or false 点击切换源代码

等效于 self.to_s.start_with?; 请参阅 String#start_with?.

static VALUE
sym_start_with(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_start_with(argc, argv, rb_sym2str(sym));
}
succ 点击切换源代码

等效于 self.to_s.succ.to_sym

:foo.succ # => :fop

相关：String#succ.

static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}
也称为别名：next
swapcase(*options) → symbol 点击切换源代码

等效于 sym.to_s.swapcase.to_sym.

请参阅 String#swapcase.

static VALUE
sym_swapcase(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_intern(rb_str_swapcase(argc, argv, rb_sym2str(sym)));
}
to_json(*a) 点击切换源代码

返回一个表示 self 的 JSON 字符串

require 'json/add/symbol'
puts :foo.to_json

输出

# {"json_class":"Symbol","s":"foo"}

# File ext/json/lib/json/add/symbol.rb, line 40
def to_json(*a)
  as_json.to_json(*a)
end
to_proc 点击切换源代码

返回一个 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"]

VALUE
rb_sym_to_proc(VALUE sym)
{
    static VALUE sym_proc_cache = Qfalse;
    enum {SYM_PROC_CACHE_SIZE = 67};
    VALUE proc;
    long index;
    ID id;

    if (!sym_proc_cache) {
        sym_proc_cache = rb_ary_hidden_new(SYM_PROC_CACHE_SIZE * 2);
        rb_gc_register_mark_object(sym_proc_cache);
        rb_ary_store(sym_proc_cache, SYM_PROC_CACHE_SIZE*2 - 1, Qnil);
    }

    id = SYM2ID(sym);
    index = (id % SYM_PROC_CACHE_SIZE) << 1;

    if (RARRAY_AREF(sym_proc_cache, index) == sym) {
        return RARRAY_AREF(sym_proc_cache, index + 1);
    }
    else {
        proc = sym_proc_new(rb_cProc, ID2SYM(id));
        RARRAY_ASET(sym_proc_cache, index, sym);
        RARRAY_ASET(sym_proc_cache, index + 1, proc);
        return proc;
    }
}
to_s → string 点击切换源代码

返回 self 的字符串表示形式（不包括前导冒号）

:foo.to_s # => "foo"

相关：Symbol#inspect, Symbol#name.

VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}
也称为别名：id2name
to_sym → self 点击切换源代码

返回 self.

相关：String#to_sym.

# File symbol.rb, line 8
def to_sym
  self
end
也称为别名：intern
upcase(*options) → symbol 点击切换源代码

等效于 sym.to_s.upcase.to_sym.

请参阅 String#upcase.

static VALUE
sym_upcase(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_intern(rb_str_upcase(argc, argv, rb_sym2str(sym)));
}