struct TOML::Any

• TOML::Any
• Struct
• Value
• Object

Overview

TOML::Any is a convenient wrapper around all possible TOML types (TOML::Any::Type) and can be used for traversing dynamic or unknown TOML structures.

Aka it's the same as what JSON::Any, and YAML::Any does but for TOML.

Defined in:

any.cr

Constructors

• .new(raw : Type)

Instance Method Summary

• #==(other : TOML::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) : TOML::Any

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

• #[](key : String) : TOML::Any

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

• #[]?(index : Int) : TOML::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) : TOML::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.

• #as_time : Time

  Checks that the underlying value is Time, and returns its value.

• #as_time? : Time | Nil

  Checks that the underlying value is Time, and returns its value.

• #as_time_span : Time::Span

  Checks that the underlying value is Time::Span, and returns its value.

• #as_time_span? : Time::Span | Nil

  Checks that the underlying value is Time::Span, and returns its value.

• #clone

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

• #dig(index_or_key : String | Int, *subkeys) : TOML::Any

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

• #dig?(index_or_key : String | Int, *subkeys) : TOML::Any | Nil

  Traverses the depth of a structure and returns the value.

• #dup

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

• #hash(hasher)

  See Object#hash(hasher)

• #raw : Type

  Returns the raw underlying value.

• #size : Int32

  Assume the underlying toml value is an Array or a Hash and returns its size raises when the underlying value is not an Array or Hash

• #to_yaml(yaml : YAML::Nodes::Builder)

Constructor Detail

Instance Method Detail