struct CON::Any

Defined in:

any.cr

Constructors

.new(token : Token, pull : CON::PullParser)
.new(raw : Type, pull : CON::PullParser | Nil = nil)
Creates a CON::Any that wraps the given value.

Class Method Summary

.from_con(pull : CON::PullParser)
Initializing document

Instance Method Summary

#==(other : CON::Any)
Returns true if both self and other's raw object are equal.
#==(other)
Returns true if the raw object is equal to other.
#[](index : Int) : CON::Any
Assumes the underlying value is an Array and returns the element at the given index.
#[](key : String) : CON::Any
Assumes the underlying value is a Hash and returns the element with the given key.
#[]?(index : Int) : CON::Any | Nil
Assumes the underlying value is an Array and returns the element at the given index, or nil if out of bounds.
#[]?(key : String) : CON::Any | Nil
Assumes the underlying value is a Hash and returns the element with the given key, or nil if the key is not present.
#as_a : Array(Any)
Checks that the underlying value is Array, and returns its value.
#as_a? : Array(Any) | Nil
Checks that the underlying value is Array, and returns its value.
#as_bool : Bool
Checks that the underlying value is Bool, and returns its value.
#as_bool? : Bool | Nil
Checks that the underlying value is Bool, and returns its value.
#as_f : Float64
Checks that the underlying value is Float, and returns its value as an Float64.
#as_f32 : Float32
Checks that the underlying value is Float, and returns its value as an Float32.
#as_f32? : Float32 | Nil
Checks that the underlying value is Float, and returns its value as an Float32.
#as_f? : Float64 | Nil
Checks that the underlying value is Float, and returns its value as an Float64.
#as_h : Hash(String, Any)
Checks that the underlying value is Hash, and returns its value.
#as_h? : Hash(String, Any) | Nil
Checks that the underlying value is Hash, and returns its value.
#as_i : Int32
Checks that the underlying value is Int, and returns its value as an Int32.
#as_i64 : Int64
Checks that the underlying value is Int, and returns its value as an Int64.
#as_i64? : Int64 | Nil
Checks that the underlying value is Int, and returns its value as an Int64.
#as_i? : Int32 | Nil
Checks that the underlying value is Int, and returns its value as an Int32.
#as_nil : Nil
Checks that the underlying value is Nil, and returns nil.
#as_s : String
Checks that the underlying value is String, and returns its value.
#as_s? : String | Nil
Checks that the underlying value is String, and returns its value.
#clone
Returns a new CON::Any instance with the #raw value #cloneed.
#dig(key : String | Int, *subkeys)
Traverses the depth of a structure and returns the value, otherwise raises.
#dig?(key : String | Int, *subkeys)
Traverses the depth of a structure and returns the value.
#dup
Returns a new CON::Any instance with the #raw value #duped.
#hash(hasher)
See Object#hash(hasher)
#raw : Type
#size : Int
Assumes the underlying value is an Array or Hash and returns its size.
#to_con(con : CON::Builder)
#to_json(json : JSON::Builder)

Instance methods inherited from struct `Value`

Instance methods inherited from class `Object`

, , ,

Constructor Detail

def self.new(token : Token, pull : CON::PullParser) #

[View source]

def self.new(raw : Type, pull : CON::PullParser | Nil = nil) #

Creates a CON::Any that wraps the given value.

[View source]

Class Method Detail

def self.from_con(pull : CON::PullParser) #

Initializing document

[View source]

Instance Method Detail

def ==(other : CON::Any) #

Returns true if both self and other's raw object are equal.

[View source]

def ==(other) #

Returns true if the raw object is equal to other.

[View source]

def [](index : Int) : CON::Any #

Assumes the underlying value is an Array and returns the element at the given index. Raises if the underlying value is not an Array.

[View source]

def [](key : String) : CON::Any #

Assumes the underlying value is a Hash and returns the element with the given key. Raises if the underlying value is not a Hash.

[View source]

def []?(index : Int) : CON::Any | Nil #

Assumes the underlying value is an Array and returns the element at the given index, or nil if out of bounds. Raises if the underlying value is not an Array.

[View source]

def []?(key : String) : CON::Any | Nil #

Assumes the underlying value is a Hash and returns the element with the given key, or nil if the key is not present. Raises if the underlying value is not a Hash.

[View source]

def as_a : Array(Any) #

Checks that the underlying value is Array, and returns its value. Raises otherwise.

[View source]

def as_a? : Array(Any) | Nil #

Checks that the underlying value is Array, and returns its value. Returns nil otherwise.

[View source]

def as_bool : Bool #

Checks that the underlying value is Bool, and returns its value. Raises otherwise.

[View source]

def as_bool? : Bool | Nil #

Checks that the underlying value is Bool, and returns its value. Returns nil otherwise.

[View source]

def as_f : Float64 #

Checks that the underlying value is Float, and returns its value as an Float64. Raises otherwise.

[View source]

def as_f32 : Float32 #

Checks that the underlying value is Float, and returns its value as an Float32. Raises otherwise.

[View source]

def as_f32? : Float32 | Nil #

Checks that the underlying value is Float, and returns its value as an Float32. Returns nil otherwise.

[View source]

def as_f? : Float64 | Nil #

Checks that the underlying value is Float, and returns its value as an Float64. Returns nil otherwise.

[View source]

def as_h : Hash(String, Any) #

Checks that the underlying value is Hash, and returns its value. Raises otherwise.

[View source]

def as_h? : Hash(String, Any) | Nil #

Checks that the underlying value is Hash, and returns its value. Returns nil otherwise.

[View source]

def as_i : Int32 #

Checks that the underlying value is Int, and returns its value as an Int32. Raises otherwise.

[View source]

def as_i64 : Int64 #

Checks that the underlying value is Int, and returns its value as an Int64. Raises otherwise.

[View source]

def as_i64? : Int64 | Nil #

Checks that the underlying value is Int, and returns its value as an Int64. Returns nil otherwise.

[View source]

def as_i? : Int32 | Nil #

Checks that the underlying value is Int, and returns its value as an Int32. Returns nil otherwise.

[View source]

def as_nil : Nil #

Checks that the underlying value is Nil, and returns nil. Raises otherwise.

[View source]

def as_s : String #

Checks that the underlying value is String, and returns its value. Raises otherwise.

[View source]

def as_s? : String | Nil #

Checks that the underlying value is String, and returns its value. Returns nil otherwise.

[View source]

def clone #

Returns a new CON::Any instance with the #raw value #cloneed.

[View source]

def dig(key : String | Int, *subkeys) #

Traverses the depth of a structure and returns the value, otherwise raises.

[View source]

def dig?(key : String | Int, *subkeys) #

Traverses the depth of a structure and returns the value. Returns nil if not found.

[View source]

def dup #

Returns a new CON::Any instance with the #raw value #duped.

[View source]

def hash(hasher) #

See Object#hash(hasher)

[View source]

def raw : Type #

[View source]

def size : Int #

Assumes the underlying value is an Array or Hash and returns its size. Raises if the underlying value is not an Array or Hash.

[View source]

def to_con(con : CON::Builder) #

[View source]

def to_json(json : JSON::Builder) #

[View source]

CrystalDoc.info

con

struct CON::Any

Defined in:

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from struct Value

Instance methods inherited from class Object

Constructor Detail

Class Method Detail

Instance Method Detail

Instance methods inherited from struct `Value`

Instance methods inherited from class `Object`