struct

HCL::Any

Inherits Struct / Value / Object

Constructors

new(hsh : Hash(String, RawType))
Source
new(array : Array(RawType))
Source
new(pull : JSON::PullParser)

Reads a HCL::Any value from the given pull parser.

Based on https://github.com/crystal-lang/crystal/blob/6952aacb37682558d1a976b4ebf1b1456d9f8b84/src/json/any.cr#L23

Source
new(raw : Array(HCL::Any) | Bool | Float64 | Hash(String, HCL::Any) | Int64 | String | Nil)
Source

Instance methods

==(other : Any)

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

Source
==(other)

Returns true if the raw object is equal to other.

Source
[](index : Int) : HCL::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.

Source
[](key : String) : HCL::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.

Source
[]?(index : Int) : HCL::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.

Source
[]?(key : String) : HCL::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.

Source
as_a

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

Source
as_a?

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

Source
as_bool

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

Source
as_bool?

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

Source
as_f

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

Source
as_f?

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

Source
as_h

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

Source
as_h?

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

Source
as_i

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

Source
as_i?

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

Source
as_nil

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

Source
as_s

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

Source
as_s?

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

Source
clone

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

Source
dig(key : String | Int, *subkeys)

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

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

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

Source
dup

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

Source
hash(hasher)

See Object#hash(hasher)

Source
raw
Source
size

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

Source
to_hcl(builder : HCL::Builder)
Source
unwrap

Unwrap HCL::Any into a HCL::Any::RawType that can be casted Array and Hash values are traversed.

NOTE: You should prefer the as_* methods instead for getting at raw values

Source

Nested types