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 <<-YAML
         ---
         foo:
           bar:
             baz:
               - qux
               - fox
         YAML
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. There are also nil-able variants (#as_i?, #as_s?, ...), which return nil when the underlying value type won't match.

Defined in:

Constructors

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

  Creates a YAML::Any that wraps the given Type.

• .new(raw : Int)

  Creates a YAML::Any that wraps the given Type.

• .new(raw : Float)

  Creates a YAML::Any that wraps the given Type.

Instance Method Summary

• #==(other : YAML::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_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 | Nil

  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(YAML::Any)

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

• #as_a? : Array(YAML::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_bytes : Bytes

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

• #as_bytes? : Bytes | Nil

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

• #as_f : Float64

  Checks that the underlying value is Float (or Int), and returns its value.

• #as_f32 : Float32

  Checks that the underlying value is Float (or Int), and returns its value as an Float32.

• #as_f32? : Float32 | Nil

  Checks that the underlying value is Float (or Int), and returns its value as an Float32.

• #as_f? : Float64 | Nil

  Checks that the underlying value is Float (or Int), and returns its value.

• #as_h : Hash(YAML::Any, YAML::Any)

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

• #as_h? : Hash(YAML::Any, YAML::Any) | Nil

  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 | Nil

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

• #as_i? : Int32 | Nil

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

• #clone

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

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

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

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

  Traverses the depth of a structure and returns the value.

• #dup

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

• #hash(hasher)

  See Object#hash(hasher)

• #inspect(io : IO) : Nil

  Appends this struct's name and instance variables names and values to the given IO.

• #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) : Nil
• #to_json_object_key : String

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

• #to_s(io : IO) : Nil

  Same as #inspect(io).

Constructor Detail

Instance Method Detail

struct Point
  def initialize(@x : Int32, @y : Int32)
  end
end

p1 = Point.new 1, 2
p1.to_s    # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"