Class: Symbol

Inherits:
Object show all
Includes:
Comparable
Defined in:
string.c,
string.c

Overview

********************************************************************

<code>Symbol</code> objects represent names and some strings
inside the Ruby
interpreter. They are generated using the <code>:name</code> and
<code>:"string"</code> literals
syntax, and by the various <code>to_sym</code> methods. The same
<code>Symbol</code> object will be created for a given name or string
for the duration of a program's execution, regardless of the context
or meaning of that name. Thus if <code>Fred</code> is a constant in
one context, a method in another, and a class in a third, the
<code>Symbol</code> <code>:Fred</code> will be the same object in
all three contexts.

   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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Comparable

#<, #<=, #>, #>=, #between?

Class Method Details

.all_symbols ⇒ Array

Returns an array of all the symbols currently in Ruby’s symbol table.

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, :$>]

Returns:



843
844
845
846
847
848
849
 
# File 'symbol.c', line 843

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

Instance Method Details

#<=>(other_symbol) ⇒ -1, ...

Compares symbol with other_symbol after calling #to_s on each of the symbols. Returns -1, 0, +1 or nil depending on whether symbol is less than, equal to, or greater than other_symbol.

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

See String#<=> for more information.

Returns:

  • (-1, 0, +1, nil) 


8794
8795
8796
8797
8798
8799
8800
8801
 
# File 'string.c', line 8794

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

#== ⇒ Object

#=== ⇒ Object

#=~(obj) ⇒ Fixnum? #match(obj) ⇒ Fixnum?

Returns sym.to_s =~ obj.

Overloads:



8828
8829
8830
8831
8832
 
# File 'string.c', line 8828

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

#[](idx) ⇒ String #[](b, n) ⇒ String #slice(idx) ⇒ String #slice(b, n) ⇒ String

Returns sym.to_s[].

Overloads:



8844
8845
8846
8847
8848
 
# File 'string.c', line 8844

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

#capitalize ⇒ Object

Same as sym.to_s.capitalize.intern.



8910
8911
8912
8913
8914
 
# File 'string.c', line 8910

static VALUE
sym_capitalize(VALUE sym)
{
    return rb_str_intern(rb_str_capitalize(rb_sym2str(sym)));
}

#casecmp(other) ⇒ -1, ...

Case-insensitive version of Symbol#<=>.

Returns:

  • (-1, 0, +1, nil) 


8811
8812
8813
8814
8815
8816
8817
8818
 
# File 'string.c', line 8811

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

#downcase ⇒ Object

Same as sym.to_s.downcase.intern.



8897
8898
8899
8900
8901
 
# File 'string.c', line 8897

static VALUE
sym_downcase(VALUE sym)
{
    return rb_str_intern(rb_str_downcase(rb_sym2str(sym)));
}

#empty? ⇒ Boolean

Returns that sym is :“” or not.

Returns:

  • (Boolean)

Returns:

  • (Boolean) 


8871
8872
8873
8874
8875
 
# File 'string.c', line 8871

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

#encoding ⇒ Encoding

Returns the Encoding object that represents the encoding of sym.

Returns:



8936
8937
8938
8939
8940
 
# File 'string.c', line 8936

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

#id2name ⇒ String #to_s ⇒ String

Returns the name or string corresponding to sym.

:fred.id2name   #=> "fred"

Overloads:



8691
8692
8693
8694
8695
 
# File 'string.c', line 8691

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

#inspect ⇒ String

Returns the representation of sym as a symbol literal.

:fred.inspect   #=> ":fred"

Returns:



8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
 
# File 'string.c', line 8650

static VALUE
sym_inspect(VALUE sym)
{
    VALUE str;
    const char *ptr;
    long len;
    char *dest;

    sym = rb_sym2str(sym);
    if (!rb_str_symname_p(sym)) {
	str = rb_str_inspect(sym);
	len = RSTRING_LEN(str);
	rb_str_resize(str, len + 1);
	dest = RSTRING_PTR(str);
	memmove(dest + 1, dest, len);
	dest[0] = ':';
    }
    else {
	rb_encoding *enc = STR_ENC_GET(sym);
	ptr = RSTRING_PTR(sym);
	len = RSTRING_LEN(sym);
	str = rb_enc_str_new(0, len + 1, enc);
	dest = RSTRING_PTR(str);
	dest[0] = ':';
	memcpy(dest + 1, ptr, len);
    }
    return str;
}

#to_sym ⇒ Object #intern ⇒ Object

In general, to_sym returns the Symbol corresponding to an object. As sym is already a symbol, self is returned in this case.



8708
8709
8710
8711
8712
 
# File 'string.c', line 8708

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

#length ⇒ Integer #size ⇒ Integer

Same as sym.to_s.length.

Overloads:



8858
8859
8860
8861
8862
 
# File 'string.c', line 8858

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

#=~(obj) ⇒ Fixnum? #match(obj) ⇒ Fixnum?

Returns sym.to_s =~ obj.

Overloads:



8828
8829
8830
8831
8832
 
# File 'string.c', line 8828

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

#succ ⇒ Object

Same as sym.to_s.succ.intern.



8774
8775
8776
8777
8778
 
# File 'string.c', line 8774

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

#length ⇒ Integer #size ⇒ Integer

Same as sym.to_s.length.

Overloads:



8858
8859
8860
8861
8862
 
# File 'string.c', line 8858

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

#[](idx) ⇒ String #[](b, n) ⇒ String #slice(idx) ⇒ String #slice(b, n) ⇒ String

Returns sym.to_s[].

Overloads:



8844
8845
8846
8847
8848
 
# File 'string.c', line 8844

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

#succ ⇒ Object

Same as sym.to_s.succ.intern.



8774
8775
8776
8777
8778
 
# File 'string.c', line 8774

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

#swapcase ⇒ Object

Same as sym.to_s.swapcase.intern.



8923
8924
8925
8926
8927
 
# File 'string.c', line 8923

static VALUE
sym_swapcase(VALUE sym)
{
    return rb_str_intern(rb_str_swapcase(rb_sym2str(sym)));
}

#to_proc ⇒ Object

Returns a Proc object which respond to the given method by sym.

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



8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
 
# File 'string.c', line 8735

static VALUE
sym_to_proc(VALUE sym)
{
    static VALUE sym_proc_cache = Qfalse;
    enum {SYM_PROC_CACHE_SIZE = 67};
    VALUE proc;
    long id, index;
    VALUE *aryp;

    if (!sym_proc_cache) {
	sym_proc_cache = rb_ary_tmp_new(SYM_PROC_CACHE_SIZE * 2);
	rb_gc_register_mark_object(sym_proc_cache);
	rb_ary_store(sym_proc_cache, SYM_PROC_CACHE_SIZE*2 - 1, Qnil);
    }

    id = SYM2ID(sym);
    index = (id % SYM_PROC_CACHE_SIZE) << 1;

    aryp = RARRAY_PTR(sym_proc_cache);
    if (aryp[index] == sym) {
	return aryp[index + 1];
    }
    else {
	proc = rb_proc_new(sym_call, (VALUE)id);
	rb_block_clear_env_self(proc);
	aryp[index] = sym;
	aryp[index + 1] = proc;
	return proc;
    }
}

#id2name ⇒ String #to_s ⇒ String

Returns the name or string corresponding to sym.

:fred.id2name   #=> "fred"

Overloads:



8691
8692
8693
8694
8695
 
# File 'string.c', line 8691

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

#to_sym ⇒ Object #intern ⇒ Object

In general, to_sym returns the Symbol corresponding to an object. As sym is already a symbol, self is returned in this case.



8708
8709
8710
8711
8712
 
# File 'string.c', line 8708

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

#upcase ⇒ Object

Same as sym.to_s.upcase.intern.



8884
8885
8886
8887
8888
 
# File 'string.c', line 8884

static VALUE
sym_upcase(VALUE sym)
{
    return rb_str_intern(rb_str_upcase(rb_sym2str(sym)));
}