struct YAML::Any

• YAML::Any
• Struct
• Value
• Object

Overview

YAML::Any is a convenient wrapper around all possible YAML core types (YAML::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.

Included Modules

• Enumerable(self)

Defined in:

Constructors

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

  Creates a YAML::Any that wraps the given YAML::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(Type)

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

• #as_a? : Array(Type)?

  Checks that the underlying value is Array, 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_f? : Float64?

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

• #as_h : Hash(Type, Type)

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

• #as_h? : Hash(Type, Type)?

  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.

• #each(&block)

  Assumes the underlying value is an Array or Hash and yields each of the elements or key/values, always as YAML::Any.

• #hash(hasher)

  See Object#hash(hasher)

• #raw : YAML::Type

  Returns the raw underlying value, a YAML::Type.

• #size : Int

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

Constructor Detail

Instance Method Detail