Symbol

Parent:ObjectIncluded modules:Comparable

Symbol对象表示Ruby解释器中的名称和一些字符串。它们是使用:name和:"string"文字语法以及各种to_sym方法生成的。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

公共类方法

all_symbols → array 显示源

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

Symbol.all_symbols.size    #=> 903
Symbol.all_symbols[1,20]   #=> [:floor, :ARGV, :Binding, :symlink,
                                :chown, :EOFError, :$;, :String,
                                :LOCK_SH, :"setuid?", :$<,
                                :default_proc, :compact, :extend,
                                :Tms, :getwd, :$=, :ThreadGroup,
                                :wait2, :$>]

VALUE
rb_sym_all_symbols(void)
{
    VALUE ary = rb_ary_new2(global_symbols.str_sym->num_entries);
    st_foreach(global_symbols.str_sym, symbols_i, ary);
    return ary;
}

json_create(o) 显示源

通过将string存储在对象中的值转换为符号来反序列化JSON字符串

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

公共实例方法

symbol <=> other_symbol → -1, 0, +1 or nil 显示源

比较symbol与other_symbol在每个符号调用to_s后。根据是否symbol小于，等于或大于，返回-1,0，+1或nil other_symbol。

+nil+ is returned if the two values are incomparable.

有关更多信息，请参阅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));
}

sym == obj → true or false 显示源

平等 - 如果sym和obj是完全相同的符号，则返回true。

#define sym_equal rb_obj_equal

sym == obj → true or false 显示源

平等 - 如果sym和obj是完全相同的符号，则返回true。

#define sym_equal rb_obj_equal

sym =~ obj → integer or nil 显示源

返回 sym.to_s =~ obj.

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

symidx → char 显示源

symb, n → string

返回sym.to_s[].

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

as_json(*) 显示源

返回一个散列，它将变成一个JSON对象并表示这个对象。

# File ext/json/lib/json/add/symbol.rb, line 9
def as_json(*)
  {
    JSON.create_id => self.class.name,
    's'            => to_s,
  }
end

capitalize options → symbol 显示源

和sym.to_s.capitalize.intern一样。

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

casecmp(other) → -1, 0, +1 or nil 显示源

不区分大小写的版本Symbol#<=>。目前，不区分大小写仅适用于字符AZ / az，而不是全部Unicode。这不同于casecmp?。

static VALUE
sym_casecmp(VALUE sym, VALUE other)
{
    if (!SYMBOL_P(other)) {
        return Qnil;
    }
    return rb_str_casecmp(rb_sym2str(sym), rb_sym2str(other));
}

casecmp?(other) → true, false, or nil 显示源

如果在Unicode大小写折叠后sym和其他值相等，则返回true，如果不相等则返回false，如果other不是符号，则返回nil。

static VALUE
sym_casecmp_p(VALUE sym, VALUE other)
{
    if (!SYMBOL_P(other)) {
        return Qnil;
    }
    return rb_str_casecmp_p(rb_sym2str(sym), rb_sym2str(other));
}

dclone() 显示源

提供了一个统一的clone操作，用于REXML :: XPathParser跨多个对象类型使用

# File lib/rexml/xpath_parser.rb, line 17
def dclone ; self ; end

downcase选项→符号显示源代码

和sym.to_s.downcase.intern一样.

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

empty? → true or false 显示源

返回sym是：“”或不。

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

encoding → encoding 显示源

返回表示sym编码的Encoding对象。

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

id2name → string 显示源

返回与sym相对应的名称或字符串。

:fred.id2name   #=> "fred"

VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}

inspect → string 显示源

将sym的表示形式返回为符号文字。

:fred.inspect   #=> ":fred"

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);
        RSTRING_GETMEM(str, ptr, len);
        str = rb_enc_str_new(0, len + 1, enc);
        dest = RSTRING_PTR(str);
        memcpy(dest + 1, ptr, len);
    }
    dest[0] = ':';
    return str;
}

intern → sym 显示源

一般而言，to_sym返回Symbol对应的对象。由于sym已经是一个符号，self在这种情况下返回。

static VALUE
sym_to_sym(VALUE sym)
{
    return sym;
}

length → integer 显示源

Same as sym.to_s.length.

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

匹配（obj）→MatchData或零显示源

返回sym.to_s.match(obj).

static VALUE
sym_match_m(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m(argc, argv, rb_sym2str(sym));
}

match?(obj) → true or false 显示源

返回sym.to_s.match?(obj)。

static VALUE
sym_match_m_p(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m_p(argc, argv, sym);
}

succ 显示源

和sym.to_s.succ.intern一样。

static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}

size → integer 显示源

和sym.to_s.length一样。

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

slice(idx) → char 显示源

slice(b, n) → string

返回sym.to_s[]。

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

succ 显示源

和sym.to_s.succ.intern一样。

static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}

swapcase options → symbol 显示源

和sym.to_s.swapcase.intern一样。

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) 显示源

将Symbol的字符串表示形式的类名称（Symbol）存储为JSON字符串。

# File ext/json/lib/json/add/symbol.rb, line 17
def to_json(*a)
  as_json.to_json(*a)
end

to_proc显示源代码

返回一个Proc对象，它通过sym响应给定的方法。

(1..3).collect(&:to_s)  #=> ["1", "2", "3"]

VALUE
rb_sym_to_proc(VALUE sym)
{
}

to_s → string 显示源

返回与sym相对应的名称或字符串。

:fred.id2name   #=> "fred"

VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}

to_sym → sym 显示源

一般而言，to_sym返回Symbol对应的对象。由于sym已经是一个符号，self在这种情况下返回。

static VALUE
sym_to_sym(VALUE sym)
{
    return sym;
}

upcase options → symbol 显示源

和sym.to_s.upcase.intern一样。

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

本文档系腾讯云开发者社区成员共同维护，如有问题请联系 cloudcommunity@tencent.com

最后更新于：2017-12-18