Spec-Zone.ru › Ruby 3

класс 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 → массив Показать исходный код
static VALUE
sym_all_symbols(VALUE _)
{
    return rb_sym_all_symbols();
}

Возвращает массив всех символов, присутствующих в таблице символов 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

Открытые методы экземпляров

символ <=> другой_символ → -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));
}

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

Если два значения несравнимы, возвращается nil.

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

сим == обьект → true или false Показать исходный код
#define sym_equal rb_obj_equal

Равенство — если сим и объект — это ровно один и тот же символ, возвращает true.

Также псевдоним для: ===

Равенство — если сим и объект — это ровно один и тот же символ, возвращает true.

Псевдоним для: ==
сим =~ объект → целое число или nil Показать исходный код
static VALUE
sym_match(VALUE sym, VALUE other)
{
    return rb_str_match(rb_sym2str(sym), other);
}

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

сим[индекс] → символ Показать исходный код
сим[нач, кол-во] → строка
static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}

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

Также псевдоним для: slice
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 → символ Показать исходный код
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.intern.

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#<=>. В настоящее время регистронезависимость работает только для символов A-Z/a-z, а не для всех символов Юникода. Это отличается от Symbol#casecmp?.

:aBcDeF.casecmp(:abcde)     #=> 1
:aBcDeF.casecmp(:abcdef)    #=> 0
:aBcDeF.casecmp(:abcdefg)   #=> -1
:abcdef.casecmp(:ABCDEF)    #=> 0

Возвращает nil, если у двух символов несовместимые кодировки или если other_symbol не является символом.

:foo.casecmp(2)   #=> nil
"\u{e4 f6 fc}".encode("ISO-8859-1").to_sym.casecmp(:"\u{c4 d6 dc}")   #=> nil
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));
}

Возвращает true если sym и other_symbol равны после сгибания регистра Юникода, false если они не равны.

:aBcDeF.casecmp?(:abcde)     #=> false
:aBcDeF.casecmp?(:abcdef)    #=> true
:aBcDeF.casecmp?(:abcdefg)   #=> false
:abcdef.casecmp?(:ABCDEF)    #=> true
:"\u{e4 f6 fc}".casecmp?(:"\u{c4 d6 dc}")   #=> true

Возвращает nil если у двух символов несовместимые кодировки или если other_symbol не является символом.

:foo.casecmp?(2)   #=> nil
"\u{e4 f6 fc}".encode("ISO-8859-1").to_sym.casecmp?(:"\u{c4 d6 dc}")   #=> nil
downcase → символ Показать исходный код
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.intern.

empty? → true или false Показать исходный код
static VALUE
sym_empty(VALUE sym)
{
    return rb_str_empty(rb_sym2str(sym));
}

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

encoding → кодировка Показать исходный код
static VALUE
sym_encoding(VALUE sym)
{
    return rb_obj_encoding(rb_sym2str(sym));
}

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

end_with?([суффиксы]+) → true или false Показать исходный код
static VALUE
sym_end_with(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_end_with(argc, argv, rb_sym2str(sym));
}

Возвращает true, если sym оканчивается одним из suffixes указанных.

:hello.end_with?("ello")               #=> true

# returns true if one of the +suffixes+ matches.
:hello.end_with?("heaven", "ello")     #=> true
:hello.end_with?("heaven", "paradise") #=> false
id2name → строка

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

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

Обратите внимание, что эта строка не заморожена (в отличие от самого символа). Чтобы получить замороженную строку, используйте name.

Псевдоним для: 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);
        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;
}

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

:fred.inspect   #=> ":fred"
intern → сим Показать исходный код
static VALUE
sym_to_sym(VALUE sym)
{
    return sym;
}

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

Также псевдоним для: to_sym
length → целое число Показать исходный код
static VALUE
sym_length(VALUE sym)
{
    return rb_str_length(rb_sym2str(sym));
}

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

Также псевдоним для: size
match(шаблон) → matchdata или nil Показать исходный код
match(шаблон, позиция) → matchdata или 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.

match?(шаблон) → true или false Показать исходный код
match?(шаблон, позиция) → 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?.

name → строка Показать исходный код
VALUE
rb_sym2str(VALUE sym)
{

}

Возвращает имя или строку, соответствующую сим. В отличие от to_s, возвращаемая строка заморожена.

:fred.name         #=> "fred"
:fred.name.frozen? #=> true
:fred.to_s         #=> "fred"
:fred.to_s.frozen? #=> false

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

Псевдоним для: succ
size → целое число

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

Псевдоним для: length
slice(индекс) → символ
slice(нач, кол-во) → строка

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

Псевдоним для: []
END_OF_DOCUMENT_MARKER
start_with?([prefixes]+) → true or false Показать исходный код
static VALUE
sym_start_with(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_start_with(argc, argv, rb_sym2str(sym));
}

Возвращает true, если sym начинается с одного из prefixes заданных значений. Каждое из prefixes должно быть String или Regexp.

:hello.start_with?("hell")               #=> true
:hello.start_with?(/H/i)                 #=> true

# returns true if one of the prefixes matches.
:hello.start_with?("heaven", "hell")     #=> true
:hello.start_with?("heaven", "paradise") #=> false
succ Показать исходный код
static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}

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

Также переименовано как: next
swapcase → символ Показать исходный код
swapcase([options]) → символ
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) с String представлением Symbol в виде JSON строки.

to_proc Показать исходный код
VALUE
rb_sym_to_proc(VALUE sym)
{
}

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

(1..3).collect(&:to_s)  #=> ["1", "2", "3"]
to_s → строка Показать исходный код
VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}

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

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

Обратите внимание, что эта строка не заморожена (в отличие от самого символа). Чтобы получить замороженную строку, используйте name.

Также переименовано как: id2name
to_sym → симв

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

Псевдоним для: intern
upcase → символ Показать исходный код
upcase([options]) → символ
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–2020 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API