struct Nil


The Nil type has only one possible value: nil.

nil is commonly used to represent the absence of a value. For example, String#index returns the position of the character or nil if it's not in the string:

str = "Hello world"
str.index 'e' # => 1
str.index 'a' # => nil

In the above example, trying to invoke a method on the returned value will give a compile time error unless both Int32 and Nil define that method:

str = "Hello world"
idx = str.index 'e'
idx + 1 # Error: undefined method '+' for Nil

The language and the standard library provide short, readable, easy ways to deal with nil, such as Object#try and Object#not_nil!:

str = "Hello world"

# The index of 'e' in str or 0 if not found
idx1 = str.index('e') || 0

idx2 = str.index('a')
if idx2
  # Compiles: idx2 can't be nil here
  idx2 + 1

# Tell the compiler that we are sure the returned
# value is not nil: raises a runtime exception
# if our assumption doesn't hold.
idx3 = str.index('o').not_nil!

See Nil literal in the language reference.

Defined in:



Instance Method Summary

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
, in?(collection : Object) : Bool
in?(*values : Object) : Bool
, inspect(io : IO) : Nil
inspect : String
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message)
, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String
, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil
, to_s(io : IO) : Nil
to_s : String
, to_yaml(io : IO) : Nil
to_yaml : String
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io, root : String)
, from_yaml(string_or_io : String | IO) from_yaml

Macros inherited from class Object

class_getter(*names, &block) class_getter, class_getter!(*names) class_getter!, class_getter?(*names, &block) class_getter?, class_property(*names, &block) class_property, class_property!(*names) class_property!, class_property?(*names, &block) class_property?, class_setter(*names) class_setter, def_clone def_clone, def_equals(*fields) def_equals, def_equals_and_hash(*fields) def_equals_and_hash, def_hash(*fields) def_hash, delegate(*methods, to object) delegate, forward_missing_to(delegate) forward_missing_to, getter(*names, &block) getter, getter!(*names) getter!, getter?(*names, &block) getter?, property(*names, &block) property, property!(*names) property!, property?(*names, &block) property?, setter(*names) setter

Constructor Detail

def : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : Nil) #

Returns true: Nil has only one singleton value: nil.

[View source]
def clone #

[View source]
def hash(hasher) #

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

Writes "nil" to the given IO.

[View source]
def inspect : String #

Returns "nil".

[View source]
def not_nil!(message = nil) : NoReturn #

Raises NilAssertionError.

If message is given, it is forwarded as error message of NilAssertionError.

See also: Object#not_nil!.

[View source]
def object_id : UInt64 #

Returns 0_u64. Even though Nil is not a Reference type, it is usually mixed with them to form nilable types so it's useful to have an object id for nil.

[View source]
def presence : Nil #

Returns self. This method enables to call the #presence method (see String#presence) on a union with Nil. The idea is to return nil when the value is nil or empty.

config = {"empty" => ""}
config["empty"]?.presence   # => nil
config["missing"]?.presence # => nil

[View source]
def same?(other : Nil) #

Returns true: Nil has only one singleton value: nil.

[View source]
def same?(other : Reference) : Bool #

Returns false.

[View source]
def to_json(json : JSON::Builder) : Nil #

[View source]
def to_json_object_key : String #

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

Doesn't write anything to the given IO.

[View source]
def to_s : String #

Returns an empty string.

[View source]
def to_yaml(yaml : YAML::Nodes::Builder) : Nil #

[View source]
def try(&) #

Doesn't yield to the block.

See also: Object#try.

[View source]