struct YAML::Any
inherits Struct

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

require "yaml"

data = YAML.parse <<-END
         ---
         foo:
           bar:
             baz:
               - qux
               - fox
         END
data["foo"]["bar"]["baz"][0].as_s # => "qux"
data["foo"]["bar"]["baz"].as_a    # => ["qux", "fox"]

Note that methods used to traverse a YAML structure, #[], #[]? and #each, always return a YAML::Any to allow further traversal. To convert them to String, Array, etc., use the as_ methods, such as #as_s, #as_a, which perform a type check against the raw underlying value. This means that invoking #as_s when the underlying value is not a String will raise: the value won't automatically be converted (parsed) to a String.

Class methods

.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

View source

.new(raw : Type)

Creates a Any that wraps the given Type.

View source

Methods

#==(other)

Returns true if the raw object is equal to other.

View source

#==(other : YAML::Any)

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

View source

#[](index_or_key) : YAML::Any

Assumes the underlying value is an Array or Hash and returns the element at the given index_or_key.

Raises if the underlying value is not an Array nor a Hash.

View source

#[]?(index_or_key) : YAML::Any?

Assumes the underlying value is an Array or Hash and returns the element at the given index_or_key, or nil if out of bounds or the key is missing.

Raises if the underlying value is not an Array nor a Hash.

View source

#as_a : Array(Any)

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

View source

#as_a? : Array(Any)?

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

View source

#as_bool : Bool

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

View source

#as_bool? : Bool?

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

View source

#as_bytes : Bytes

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

View source

#as_bytes? : Bytes?

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

View source

#as_f : Float64

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

View source

#as_f32 : Float32

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

View source

#as_f32? : Float32?

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

View source

#as_f? : Float64?

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

View source

#as_h : Hash(Any, Any)

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

View source

#as_h? : Hash(Any, Any)?

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

View source

#as_i : Int32

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

View source

#as_i64 : Int64

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

View source

#as_i64? : Int64?

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

View source

#as_i? : Int32?

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

View source

#as_nil : Nil

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

View source

#as_s : String

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

View source

#as_s? : String?

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

View source

#as_time : Time

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

View source

#as_time? : Time?

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

View source

#clone

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

View source

#dig(index_or_key, *subkeys) : YAML::Any

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

View source

#dig?(index_or_key, *subkeys) : YAML::Any?

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

View source

#dup

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

View source

#hash(hasher)

See Object#hash(hasher)

View source

#raw : Type

Returns the raw underlying value, a Type.

View source

#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

#to_json(builder : JSON::Builder)

View source

#to_json_object_key

Forwards to_json_object_key to raw if it responds to that method, raises JSON::Error otherwise.

View source