Spec-Zone.ru › Ruby 3.1

класс Symbol

Родитель:
Объект
Включенные модули:
Comparable

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?

    Возвращает true, если self.length равно нулю; false в противном случае.

  • encoding

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

  • end_with?

    Возвращает true, если символ заканчивается любой из заданных строк.

  • match

    Возвращает объект MatchData, если символ соответствует заданному Regexp; nil в противном случае.

  • match?

    Возвращает true, если символ соответствует заданному Regexp; false в противном случае.

  • length, size

    Возвращает количество символов в символе.

  • start_with?

    Возвращает true, если символ начинается с любой из заданных строк.

Методы для сравнения

  • #<=>

    Возвращает -1, 0 или 1, в зависимости от того, меньше ли заданный символ, равен ли он или больше, чем символ.

  • #==, #===

    Возвращает true, если заданный символ имеет то же содержимое и кодировку.

  • casecmp

    Игнорируя регистр, возвращает -1, 0 или 1, в зависимости от того, меньше ли заданный символ, равен ли он или больше, чем символ.

  • casecmp?

    Возвращает 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    #=> 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

END_OF_DOCUMENT_MARKER

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

символ <=> другой_символ → -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#<=> для получения дополнительной информации.

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

Равенство—Если sym и obj являются точно одним и тем же символом, возвращает true.

Также алиас для: ===
===(p1)

Равенство—Если sym и obj являются точно одним и тем же символом, возвращает true.

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

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

sym[idx] → символ Показать исходный код
sym[b, n] → строка
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(*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#<=>:

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

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

sym = "\u{e4 f6 fc}".encode("ISO-8859-1").to_sym
other_sym = :"\u{c4 d6 dc}"
sym.casecmp(other_sym) # => nil
:foo.casecmp(2)        # => nil

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

Связанно: Symbol#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));
}

Возвращает 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 не является символом:

sym = "\u{e4 f6 fc}".encode("ISO-8859-1").to_sym
other_sym = :"\u{c4 d6 dc}"
sym.casecmp?(other_sym) # => nil
:foo.casecmp?(2)        # => nil

См. Преобразование регистра.

Связанно: Symbol#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));
}

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

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

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

end_with?([suffixes]+) → 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 → строка

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

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

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

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

В общем случае to_sym возвращает Symbol, соответствующий объекту. Поскольку sym уже является символом, в этом случае возвращается 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)
{

}

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

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

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

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

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

Псевдоним для: length
END_OF_DOCUMENT_MARKER
slice(idx) → char
slice(b, n) → string

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

Псевдоним для: []
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(*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.to_sym.

См. String#swapcase.

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 → 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"

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

Также алиасируется как: id2name
to_sym → sym

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

Псевдоним для: intern
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.to_sym.

См. String#upcase.

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

Spec-Zone.ru

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