класс Symbol

Родительский класс:: Object
Подключённые модули:: 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, если символ равен заданному символу после преобразования регистра Unicode; в противном случае — false.

Методы для преобразования

capitalize: Возвращает символ, у которого первый символ преобразован в верхний регистр, а все остальные — в нижний.
downcase: Возвращает символ, у которого все символы преобразованы в нижний регистр.
inspect: Возвращает строковое представление self в виде литерала символа.
name: Возвращает замороженную строку, соответствующую символу.
succ, next: Возвращают символ, следующий за данным символом.
swapcase: Возвращает символ, в котором все символы верхнего регистра преобразованы в нижний, а все символы нижнего регистра — в верхний.
to_proc: Возвращает объект Proc, который вызывает метод с именем, заданным символом.
to_s, id2name: Возвращают строку, соответствующую self.
to_sym, intern: Возвращают self.
upcase: Возвращает символ, у которого все символы преобразованы в верхний регистр.

Открытые методы класса

all_symbols → array_of_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 49
def self.json_create(o)
  o['s'].to_sym
end

См. as_json.

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

self <=> other → -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));
}

Сравнивает self и other с помощью String#<=>.

Возвращает:

self.to_s <=> other.to_s, если other является символом.
nil в противном случае.

Примеры:

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

Класс Symbol подключает модуль Comparable; каждый из его методов использует Symbol#<=> для сравнения.

Связанный метод: String#<=>.

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

#define sym_equal rb_obj_equal

Возвращает true, если object является тем же объектом, что и self; в противном случае возвращает false.

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

===

Псевдоним для: ==

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

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

Эквивалентен symbol.to_s =~ object, включая возможное обновление глобальных переменных; см. String#=~.

symbol[index] → string or nil Показать исходный код

symbol[start, length] → string or nil

symbol[range] → string or nil

symbol[regexp, capture = 0] → string or nil

symbol[substring] → string or 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:

require 'json/add/symbol'
x = :foo.as_json
# => {"json_class"=>"Symbol", "s"=>"foo"}

Метод JSON.create десериализует такой хеш и возвращает объект Symbol:

Symbol.json_create(x) # => :foo

capitalize(mapping) → 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.to_sym.

См. String#capitalize.

casecmp(object) → -1, 0, 1, or 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

Возвращает nil, если self и object имеют несовместимые кодировки или если object не является символом:

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?(object) → true, false, or 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, если self и object равны после преобразования регистра Unicode; в противном случае возвращает false:

lower = :abc
upper = :ABC
upper.casecmp?(lower) # => true
lower.casecmp?(lower) # => true
lower.casecmp?(upper) # => true

Возвращает nil, если self и object имеют несовместимые кодировки или если object не является символом:

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(mapping) → 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.to_sym.

См. String#downcase.

Связанный метод: Symbol#upcase.

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

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

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

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

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

Эквивалентен self.to_s.encoding; см. String#encoding.

end_with?(*strings) → true or 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 → 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);
        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 → integer Показать исходный код

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 or nil Показать исходный код

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

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 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?; см. String#match.

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

# 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

size

Псевдоним для: length

slice

Псевдоним для: []

start_with?(*string_or_regexp) → true or false Показать исходный код

static VALUE
sym_start_with(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_start_with(argc, argv, rb_sym2str(sym));
}

Эквивалентен self.to_s.start_with?; см. String#start_with?.

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

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

Эквивалентен self.to_s.succ.to_sym:

:foo.succ # => :fop

Связанный метод: String#succ.

Также имеет псевдоним: next

swapcase(mapping) → 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 (state = nil, *a) Показать исходный код

# File ext/json/lib/json/add/symbol.rb, line 39
def to_json(state = nil, *a)
  state = ::JSON::State.from_state(state)
  if state.strict?
    super
  else
    as_json.to_json(state, *a)
  end
end

Возвращает строку в формате JSON, представляющую self:

require 'json/add/symbol'
puts :foo.to_json

Результат:

# {"json_class":"Symbol","s":"foo"}

Вызывает метод суперкласса

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

VALUE
rb_sym_to_proc(VALUE sym)
{
    enum {SYM_PROC_CACHE_SIZE = 67};

    if (rb_ractor_main_p()) {
        if (!sym_proc_cache) {
            sym_proc_cache = rb_ary_hidden_new(SYM_PROC_CACHE_SIZE);
            rb_ary_store(sym_proc_cache, SYM_PROC_CACHE_SIZE - 1, Qnil);
        }

        ID id = SYM2ID(sym);
        long index = (id % SYM_PROC_CACHE_SIZE);
        VALUE procval = RARRAY_AREF(sym_proc_cache, index);
        if (RTEST(procval)) {
            rb_proc_t *proc;
            GetProcPtr(procval, proc);

            if (proc->block.as.symbol == sym) {
                return procval;
            }
        }

        procval = sym_proc_new(rb_cProc, sym);
        RARRAY_ASET(sym_proc_cache, index, procval);

        return RB_GC_GUARD(procval);
    }
    else {
        return sym_proc_new(rb_cProc, sym);
    }
}

Возвращает объект Proc, который вызывает метод с именем self для первого параметра и передаёт методу остальные параметры.

proc = :to_s.to_proc   # => #<Proc:0x000001afe0e48680(&:to_s) (lambda)>
proc.call(1000)        # => "1000"
proc.call(1000, 16)    # => "3e8"
(1..3).collect(&:to_s) # => ["1", "2", "3"]

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

# File symbol.rb, line 10
def to_s
  Primitive.attr! :leaf
  Primitive.cexpr! 'rb_sym_to_s(self)'
end

Возвращает строковое представление self (без начального двоеточия):

:foo.to_s # => "foo"

Связанные методы: Symbol#inspect, Symbol#name.

Также имеет псевдоним: id2name

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

# File symbol.rb, line 37
def to_sym
  self
end

Возвращает self.

Связанный метод: String#to_sym.

Также имеет псевдоним: intern

upcase(mapping) → 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–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.