класс Symbol

Родитель:: Объект
Включённые модули:: 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 → массив Показать исходный код

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

Возвращает массив всех символов, которые в настоящее время находятся в таблице символов 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, :$>]

json_create(o) Показать исходный код

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

Десериализует строку JSON, преобразуя значение string хранящееся в объекте, в символ

Публичные методы экземпляра

symbol <=> other_symbol → -1, 0, +1 or 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));
}

Сравнивает symbol с other_symbol после вызова to_s для каждого из символов. Возвращает -1, 0, +1 или nil в зависимости от того, является ли symbol меньше, равно или больше other_symbol.

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

См. String#<=> для получения дополнительной информации.

sym == obj → true or false Показать исходный код

#define sym_equal rb_obj_equal

Равенство—Если sym и obj это совершенно одинаковые символы, возвращает true.

sym == obj → true or false Показать исходный код

#define sym_equal rb_obj_equal

Равенство—Если sym и obj это совершенно одинаковые символы, возвращает true.

sym =~ obj → integer or nil Показать исходный код

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

Возвращает sym.to_s =~ obj.

sym[idx] → char Показать исходный код

sym[b, n] → string

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

Возвращает sym.to_s[].

as_json(*) Показать исходный код

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

Возвращает хэш, который будет преобразован в объект JSON и будет представлять этот объект.

capitalize [options] → symbol Показать исходный код

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.intern.

casecmp(other) → -1, 0, +1 or nil Показать исходный код

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

Версия Symbol#<=> без учёта регистра. В настоящее время регистронезависимость работает только для символов A-Z/a-z, а не для всего Unicode. Это отличается от casecmp?.

casecmp?(other) → true, false, or 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));
}

Возвращает true, если sym и other равны после сворачивания регистра Unicode, false, если они не равны, и nil, если other не является символом.

dclone() Показать исходный код

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

предоставляет унифицированную операцию clone, для использования REXML::XPathParser в нескольких типах объектов Object

downcase [options] → symbol Показать исходный код

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.intern.

empty? → true or false Показать исходный код

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

Возвращает, является ли sym :“” или нет.

encoding → encoding Показать исходный код

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

Возвращает объект Encoding, который представляет кодировку sym.

id2name → string Показать исходный код

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

Возвращает имя или строку, соответствующую sym.

:fred.id2name   #=> "fred"
:ginger.to_s    #=> "ginger"

inspect → string Показать исходный код

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

Возвращает представление sym в виде символьного литерала.

:fred.inspect   #=> ":fred"

intern → sym Показать исходный код

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

В общем, to_sym возвращает Symbol, соответствующий объекту. Так как sym уже является символом, в этом случае возвращается self.

length → integer Показать исходный код

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

То же, что и sym.to_s.length.

match(obj) → MatchData or nil Показать исходный код

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

Возвращает sym.to_s.match(obj).

match?(obj) → true or 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?(obj).

succ Показать исходный код

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

То же, что и sym.to_s.succ.intern.

size → integer Показать исходный код

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

То же, что и sym.to_s.length.

slice(idx) → char Показать исходный код

slice(b, n) → string

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

Возвращает sym.to_s[].

succ Показать исходный код

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

То же, что и sym.to_s.succ.intern.

swapcase [options] → symbol Показать исходный код

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.intern.

to_json(*a) Показать исходный код

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

Сохраняет имя класса (Symbol) со строковым представлением Symbol как строку JSON.

to_proc Показать исходный код

VALUE
rb_sym_to_proc(VALUE sym)
{
}

Возвращает объект Proc, который отвечает на заданный метод sym.

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

to_s → string Показать исходный код

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

Возвращает имя или строку, соответствующую sym.

:fred.id2name   #=> "fred"
:ginger.to_s    #=> "ginger"

to_sym → sym Показать исходный код

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

В общем случае, to_sym возвращает Symbol , соответствующее объекту. Поскольку sym уже является символом, в этом случае возвращается self.

upcase [options] → symbol Показать исходный код

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.intern.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.