# struct YAML::Any

- YAML::Any
- Struct
- Value
- Object

##
Overview

`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`.

##
Defined in:

##
Constructors

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

  Creates a `Any` that wraps the given `Type`.

##
Instance Method Summary

- #==(other)

  Returns `true` if the raw object is equal to other.

- #==(other : YAML::Any)

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

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

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

- #[]?(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.

- #as_a : Array(Any)

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

- #as_a? : Array(Any)?

  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?

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

- #as_bytes : Bytes

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

- #as_bytes? : Bytes?

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

- #as_f : Float64

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

- #as_f32 : Float32

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

- #as_f32? : Float32?

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

- #as_f? : Float64?

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

- #as_h : Hash(Any, Any)

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

- #as_h? : Hash(Any, Any)?

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

- #as_i : Int32

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

- #as_i64 : Int64

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

- #as_i64? : Int64?

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

- #as_i? : Int32?

  Checks that the underlying value is `Int64`, and returns its value as `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?

  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?

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

- #clone

  Returns a new YAML::Any instance with the `#raw` value `#clone`ed.

- #dig(index_or_key, *subkeys)

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

- #dig?(index_or_key, *subkeys)

  Traverses the depth of a structure and returns the value.

- #dup

  Returns a new YAML::Any instance with the `#raw` value `#dup`ed.

- #hash(hasher)

  See `Object#hash(hasher)`

- #raw : Type

  Returns the raw underlying value, a `Type`.

- #size : Int

  Assumes the underlying value is an `Array` or `Hash` and returns its size.

- #to_json(builder : JSON::Builder)
- #to_json_object_key

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

### Instance methods inherited from struct `Struct`

==(other) : Bool ==, hash(hasher) hash, inspect(io : IO) : Nil inspect, pretty_print(pp) : Nil pretty_print, to_s(io : IO) : Nil to_s

### Instance methods inherited from struct `Value`

==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup

### Instance methods inherited from class `Object`

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, __crystal_pseudo_! : Bool __crystal_pseudo_!, __crystal_pseudo_as(type : Class) __crystal_pseudo_as, __crystal_pseudo_as?(type : Class) __crystal_pseudo_as?, __crystal_pseudo_is_a?(type : Class) : Bool __crystal_pseudo_is_a?, __crystal_pseudo_nil? : Bool __crystal_pseudo_nil?, __crystal_pseudo_responds_to?(name : Symbol) : Bool __crystal_pseudo_responds_to?, class class, dup dup, hash(hasher)
hash hash, inspect : String
inspect(io : IO) : Nil inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s : String
to_s(io : IO) : Nil to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

### Class methods inherited from class `Object`

from_json(string_or_io, root : String)
from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml

##
Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #
def self.new(raw : Type) #

Creates a `Any` that wraps the given `Type`.

##
Instance Method Detail

def ==(other) #

Returns `true` if the raw object is equal to other.

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

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

def [](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`.

def []?(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`.

def as_a : Array(Any) #

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

def as_a? : Array(Any)? #

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

def as_bool : Bool #

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

def as_bool? : Bool? #

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

def as_bytes : Bytes #

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

def as_bytes? : Bytes? #

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

def as_f : Float64 #

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

def as_f32 : Float32 #

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

def as_f32? : Float32? #

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

def as_f? : Float64? #

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

def as_h : Hash(Any, Any) #

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

def as_h? : Hash(Any, Any)? #

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

def as_i : Int32 #

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

def as_i64 : Int64 #

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

def as_i64? : Int64? #

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

def as_i? : Int32? #

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

def as_nil : Nil #

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

def as_s : String #

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

def as_s? : String? #

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

def as_time : Time #

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

def as_time? : Time? #

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

def clone #

Returns a new YAML::Any instance with the `#raw` value `#clone`ed.

def dig(index_or_key, *subkeys) #

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

def dig?(index_or_key, *subkeys) #

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

def dup #

Returns a new YAML::Any instance with the `#raw` value `#dup`ed.

def hash(hasher) #

See `Object#hash(hasher)`

def raw : Type #

Returns the raw underlying value, a `Type`.

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`.

def to_json(builder : JSON::Builder) #
def to_json_object_key #

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