 class Symbol 

Parent:
Object
Included modules:
Comparable
  Symbol objects represent names and some strings inside the Ruby interpreter. They are generated using the :name and :"string" literals syntax, and by the various to_sym methods. The same Symbol 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 Fred is a constant in one context, a method in another, and a class in a third, the Symbol :Fred 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
     Public Class Methods     all_symbols → array  Show source  
 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;
}  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, :$>]     json_create(o) Show source  
 # File ext/json/lib/json/add/symbol.rb, line 22
def self.json_create(o)
  o['s'].to_sym
end  Deserializes JSON string by converting the string value stored in the object to a Symbol      Public Instance Methods     symbol <=> other_symbol → -1, 0, +1, or nil  Show source  
 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));
}  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.      sym == obj → true or false  Show source  
 #define sym_equal rb_obj_equal  Equality—If sym and obj are exactly the same symbol, returns true.      sym == obj → true or false  Show source  
 #define sym_equal rb_obj_equal  Equality—If sym and obj are exactly the same symbol, returns true.      sym =~ obj → integer or nil  Show source  
 static VALUE
sym_match(VALUE sym, VALUE other)
{
    return rb_str_match(rb_sym2str(sym), other);
}  Returns sym.to_s =~ obj.      sym[idx] → char  Show source    sym[b, n] → string   
 static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}  Returns sym.to_s[].     as_json(*) Show source  
 # File ext/json/lib/json/add/symbol.rb, line 9
def as_json(*)
  {
    JSON.create_id => self.class.name,
    's'            => to_s,
  }
end  Returns a hash, that will be turned into a JSON object and represent this object.      capitalize → symbol  Show source    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)));
}  Same as sym.to_s.capitalize.intern.      casecmp(other_symbol) → -1, 0, +1, or nil  Show source  
 static VALUE
sym_casecmp(VALUE sym, VALUE other)
{
    if (!SYMBOL_P(other)) {
        return Qnil;
    }
    return str_casecmp(rb_sym2str(sym), rb_sym2str(other));
}  Case-insensitive version of Symbol#<=>. Currently, case-insensitivity only works on characters A-Z/a-z, not all of Unicode. This is different from Symbol#casecmp?. :aBcDeF.casecmp(:abcde)     #=> 1
:aBcDeF.casecmp(:abcdef)    #=> 0
:aBcDeF.casecmp(:abcdefg)   #=> -1
:abcdef.casecmp(:ABCDEF)    #=> 0
 nil is returned if the two symbols have incompatible encodings, or if other_symbol is not a symbol. :foo.casecmp(2)   #=> nil
"\u{e4 f6 fc}".encode("ISO-8859-1").to_sym.casecmp(:"\u{c4 d6 dc}")   #=> nil
      casecmp?(other_symbol) → true, false, or nil  Show source  
 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));
}  Returns true if sym and other_symbol are equal after Unicode case folding, false if they are not equal. :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 is returned if the two symbols have incompatible encodings, or if other_symbol is not a symbol. :foo.casecmp?(2)   #=> nil
"\u{e4 f6 fc}".encode("ISO-8859-1").to_sym.casecmp?(:"\u{c4 d6 dc}")   #=> nil
     dclone() Show source  
 # File lib/rexml/xpath_parser.rb, line 18
def dclone ; self ; end  provides a unified clone operation, for REXML8b7c:f320:99b9:690f:4595:cd17:293a:c069XPathParser to use across multiple Object types      downcase → symbol  Show source    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)));
}  Same as sym.to_s.downcase.intern.      empty? → true or false  Show source  
 static VALUE
sym_empty(VALUE sym)
{
    return rb_str_empty(rb_sym2str(sym));
}  Returns whether sym is :“” or not.      encoding → encoding  Show source  
 static VALUE
sym_encoding(VALUE sym)
{
    return rb_obj_encoding(rb_sym2str(sym));
}  Returns the Encoding object that represents the encoding of sym.      id2name → string  Show source  
 VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}  Returns the name or string corresponding to sym. :fred.id2name   #=> "fred"
:ginger.to_s    #=> "ginger"
      inspect → string  Show source  
 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;
}  Returns the representation of sym as a symbol literal. :fred.inspect   #=> ":fred"
      intern → sym  Show source  
 static VALUE
sym_to_sym(VALUE sym)
{
    return sym;
}  In general, to_sym returns the Symbol corresponding to an object. As sym is already a symbol, self is returned in this case.      length → integer  Show source  
 static VALUE
sym_length(VALUE sym)
{
    return rb_str_length(rb_sym2str(sym));
}  Same as sym.to_s.length.      match(pattern) → matchdata or nil  Show source    match(pattern, pos) → matchdata or nil   
 static VALUE
sym_match_m(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m(argc, argv, rb_sym2str(sym));
}  Returns sym.to_s.match.      match?(pattern) → true or false  Show source    match?(pattern, pos) → true or false   
 static VALUE
sym_match_m_p(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_match_m_p(argc, argv, sym);
}  Returns sym.to_s.match?.      succ  Show source  
 static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}  Same as sym.to_s.succ.intern.      size → integer  Show source  
 static VALUE
sym_length(VALUE sym)
{
    return rb_str_length(rb_sym2str(sym));
}  Same as sym.to_s.length.      slice(idx) → char  Show source    slice(b, n) → string   
 static VALUE
sym_aref(int argc, VALUE *argv, VALUE sym)
{
    return rb_str_aref_m(argc, argv, rb_sym2str(sym));
}  Returns sym.to_s[].      succ  Show source  
 static VALUE
sym_succ(VALUE sym)
{
    return rb_str_intern(rb_str_succ(rb_sym2str(sym)));
}  Same as sym.to_s.succ.intern.      swapcase → symbol  Show source    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)));
}  Same as sym.to_s.swapcase.intern.     to_json(*a) Show source  
 # File ext/json/lib/json/add/symbol.rb, line 17
def to_json(*a)
  as_json.to_json(*a)
end  Stores class name (Symbol) with String representation of Symbol as a JSON string.      to_proc  Show source  
 VALUE
rb_sym_to_proc(VALUE sym)
{
}  Returns a Proc object which responds to the given method by sym. (1..3).collect(&:to_s)  #=> ["1", "2", "3"]
      to_s → string  Show source  
 VALUE
rb_sym_to_s(VALUE sym)
{
    return str_new_shared(rb_cString, rb_sym2str(sym));
}  Returns the name or string corresponding to sym. :fred.id2name   #=> "fred"
:ginger.to_s    #=> "ginger"
      to_sym → sym  Show source  
 static VALUE
sym_to_sym(VALUE sym)
{
    return sym;
}  In general, to_sym returns the Symbol corresponding to an object. As sym is already a symbol, self is returned in this case.      upcase → symbol  Show source    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)));
}  Same as sym.to_s.upcase.intern.    

    Ruby Core © 1993–2017 Yukihiro MatsumotoLicensed under the Ruby License.Ruby Standard Library 
{'path': 'public/docs/ruby~2.6/symbol.html', 'source': 'DevDocs.IO'}