struct Nil

Overview

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
end

# 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:

ssz/codec.cr
ssz/hash_tree_root.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from class Object

ssz_basic? : Bool ssz_basic?, ssz_encode(io : IO)
ssz_encode : Bytes
ssz_encode
, ssz_fixed? : Bool ssz_fixed?, ssz_size : Int32 ssz_size, ssz_variable? : Bool ssz_variable?

Class methods inherited from class Object

ssz_basic? : Bool ssz_basic?, ssz_decode(io : IO, size : Int32 = 0)
ssz_decode(bytes : Bytes)
ssz_decode
, ssz_fixed? : Bool ssz_fixed?, ssz_variable? : Bool ssz_variable?

Class Method Detail

def self.ssz_basic? : Bool #

[View source]
def self.ssz_decode(bytes : Bytes, size : Int32 = 0) #

[View source]
def self.ssz_decode(io : IO) #

[View source]
def self.ssz_variable? : Bool #

[View source]

Instance Method Detail

def hash_tree_root : Bytes #

[View source]
def ssz_basic? : Bool #

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

[View source]
def ssz_encode : Bytes #

[View source]
def ssz_size : Int32 #

[View source]
def ssz_variable? : Bool #

[View source]