struct Symbol


A symbol is a constant that is identified by a name without you having to give it a numeric value.

:"symbol with spaces"

Internally a symbol is represented as an Int32, so it's very efficient.

You can't dynamically create symbols. When you compile your program, each symbol gets assigned a unique number.

Included Modules

Defined in:

Class Method Summary

Instance Method Summary

Instance methods inherited from module Comparable(T)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from struct Value

==(other) ==

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any)
, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO)
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
, to_s
to_s(io : IO)
, to_yaml(io : IO)
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) : self from_json, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s, |(other : U.class) |

Class Method Detail

def self.needs_quotes?(string) : Bool #

Determines if a string needs to be quoted to be used for a symbol.

Symbol.needs_quotes? "string"      # => false
Symbol.needs_quotes? "long string" # => true

[View source]

Instance Method Detail

def !=(other : Symbol) : Bool #

Returns true if self is not equal to other.

[View source]
def <=>(other : Symbol) #

Compares symbol with other based on String#<=> method. Returns -1, 0 or +1 depending on whether symbol is less than, equal to, or greater than other_symbol. See String#<=> for more information.

[View source]
def ==(other : Symbol) : Bool #

Returns true if self is equal to other.

[View source]
def hash : Int32 #

Generates an Int32 hash value for this symbol.

See Object#hash.

[View source]
def inspect(io : IO) #

Returns the symbol literal representation as a string.

:crystal.inspect # => ":crystal"

[View source]
def to_i : Int32 #

Returns a unique number for this symbol.

[View source]
def to_json(io) #

[View source]
def to_s : String #

Returns the symbol's name as a String.

:foo.to_s           # => "foo"
:"hello world".to_s # => "hello world"

[View source]
def to_s(io : IO) #

Appends the symbol's name to the passed IO.

:crystal.to_s # => "crystal"

[View source]
def to_yaml(yaml : YAML::Generator) #

[View source]