class 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 符号表中当前所有符号的数组。

  • #=~：返回符号中与给定 Regexp 或其他对象匹配的第一个子字符串的索引；如果未找到匹配项，则返回 nil。

  • []，slice : 返回由给定索引、起始位置/长度、范围或字符串确定的符号的子字符串。

  • empty?：如果 self.length 为零，则返回 true；否则返回 false。

  • encoding：返回表示符号编码的 Encoding 对象。

  • end_with?：如果符号以任何给定的字符串结尾，则返回 true。

  • match：如果符号与给定的 Regexp 匹配，则返回 MatchData 对象；否则返回 nil。

  • match?：如果符号与给定的 Regexp 匹配，则返回 true；否则返回 false。

  • length，size：返回符号中的字符数。

  • start_with?：如果符号以任何给定的字符串开头，则返回 true。

比较方法 ↑

  • #<=>：返回 -1、0 或 1，分别表示给定符号小于、等于或大于该符号。

  • ==，===：如果给定符号具有相同的内容和编码，则返回 true。

  • casecmp：忽略大小写，返回 -1、0 或 1，分别表示给定符号小于、等于或大于该符号。

  • casecmp?：如果符号在 Unicode 大小写折叠后等于给定符号，则返回 true；否则返回 false。

转换方法 ↑

  • capitalize：返回首字符大写且所有其他字符小写的符号。

  • downcase：返回所有字符都小写的符号。

  • inspect：返回 self 的字符串表示形式，即符号字面量。

  • name：返回与符号对应的冻结字符串。

  • succ，next：返回符号的后继符号。

  • swapcase：返回所有大写字符都小写，所有小写字符都大写的符号。

  • to_proc：返回一个 Proc 对象，该对象响应由符号命名的方法。

  • to_s，id2name：返回与 self 对应的字符串。

  • to_sym，intern：返回 self。

  • upcase：返回所有字符都大写的符号。

公共类方法

all_symbols → array_of_symbols 点击以切换源代码

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

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

static VALUE
sym_all_symbols(VALUE _)
{
    return rb_sym_all_symbols();
}

公共实例方法

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
别名为：===
===(p1)

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

别名为：==
symbol =~ object → integer 或 nil 点击以切换源代码

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

static VALUE
sym_match(VALUE sym, VALUE other)
{
    return rb_str_match(rb_sym2str(sym), other);
}
symbol[index] → string 或 nil 点击以切换源代码
symbol[start, length] → string 或 nil
symbol[range] → string 或 nil
symbol[regexp, capture = 0] → string 或 nil
symbol[substring] → string 或 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
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;

        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;
}
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。

# File ruby_3_4_1/symbol.rb, line 26
def name
  Primitive.attr! :leaf
  Primitive.cexpr! 'rb_sym2str(self)'
end
next()

等效于 self.to_s.succ.to_sym

:foo.succ # => :fop

相关：String#succ。

别名为：succ
size()

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

别名为：length
slice(*args)

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

别名为：[]
start_with?(*string_or_regexp) → true 或 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_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_vm_register_global_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。

# File ruby_3_4_1/symbol.rb, line 10
def to_s
  Primitive.attr! :leaf
  Primitive.cexpr! 'rb_sym_to_s(self)'
end
别名为：id2name
to_sym → self 点击切换源

返回 self。

相关链接：String#to_sym。

# File ruby_3_4_1/symbol.rb, line 37
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)));
}