类 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

继承自类 Object。
包含模块 Comparable。

在这里，类 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 → 符号数组

源代码

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

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

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

json_create (o)

源代码

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

请参阅 as_json。

公共实例方法

符号 <=> 对象 → -1、0、+1 或 nil

源代码

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

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

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

否则，返回 nil

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

相关：String#<=>。

符号 == 对象 → true 或 false

源代码

#define sym_equal rb_obj_equal

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

也别名为：===

===

别名为：==

符号 =~ 对象 → 整数或 nil

源代码

static VALUE
sym_match(VALUE sym, VALUE other)
{
    return rb_str_match(rb_sym2str(sym), other);
}

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

符号[索引] → 字符串或 nil

符号[开始, 长度] → 字符串或 nil

符号[范围] → 字符串或 nil

符号[正则表达式, 捕获 = 0] → 字符串或 nil

符号[子字符串] → 字符串或 nil

源代码

static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}

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

也别名为：slice

as_json (*)

源代码

# 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

capitalize(*options) → 符号

源代码

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。

请参阅 String#capitalize。

casecmp(对象) → -1、0、1 或 nil

源代码

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

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

casecmp?(对象) → true、false 或 nil

源代码

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

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

downcase(*options) → 符号

源代码

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

等效于 sym.to_s.downcase.to_sym。

请参阅 String#downcase。

相关：Symbol#upcase。

empty? → true 或 false

源代码

static VALUE
sym_empty(VALUE sym)
{
    return rb_str_empty(rb_sym2str(sym));
}

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

encoding → 编码

源代码

static VALUE
sym_encoding(VALUE sym)
{
    return rb_obj_encoding(rb_sym2str(sym));
}

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

end_with?(*strings) → true 或 false

源代码

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?。

id2name

别名为：to_s

inspect → 字符串

源代码

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

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

:foo.inspect # => ":foo"

相关：Symbol#to_s、Symbol#name。

intern

别名为：to_sym

length → 整数

源代码

static VALUE
sym_length(VALUE sym)
{
    return rb_str_length(rb_sym2str(sym));
}

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

也别名为：size

match(pattern, offset = 0) → matchdata 或 nil

match(pattern, offset = 0) {|matchdata| } → 对象

源代码

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。

match?(pattern, offset) → true 或 false

源代码

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。

name → 字符串

源代码

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

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

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

相关：Symbol#to_s、Symbol#inspect。

succ

等效于 self.to_s.succ.to_sym

:foo.succ # => :fop