JSON::Any

struct JSON::Any

Overview

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

obj = JSON.parse(%({"access": [{"name": "mapping", "speed": "fast"}, {"name": "any", "speed": "slow"}]}))
obj["access"][1]["name"].as_s  # => "any"
obj["access"][1]["speed"].as_s # => "slow"

Note that methods used to traverse a JSON structure, #[], #[]? and #each, always return a JSON::Any to allow further traversal- To convert them to String, Int32, etc., use the as_ methods, such as #as_s, #as_i, 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:

json/any.cr

Class Method Summary

.new(raw : JSON::Type)
Creates a JSON::Any that wraps the given JSON::Type.
.new(pull : JSON::PullParser)
Reads a JSON::Any value from the given pull parser-

Instance Method Summary

#==(other)
Returns true if the raw object is equal to other.
#==(other : JSON::Any)
Returns true if both self and other's raw object are equal.
#[](index : Int) : JSON::Any
Assumes the underlying value is an Array and returns the element at the given index.
#[](key : String) : JSON::Any
Assumes the underlying value is a Hash and returns the element with the given key.
#[]?(index : Int) : JSON::Any?
Assumes the underlying value is an Array and returns the element at the given index, or nil if out of bounds.
#[]?(key : String) : JSON::Any?
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(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_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_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?
Checks that the underlying value is Float, and returns its value as an Float32.
#as_f? : Float64?
Checks that the underlying value is Float, and returns its value as an Float64.
#as_h : Hash(String, Type)
Checks that the underlying value is Hash, and returns its value.
#as_h? : Hash(String, Type)?
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?
Checks that the underlying value is Int, and returns its value as an Int64.
#as_i? : Int32?
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?
Checks that the underlying value is String, 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 JSON::Any-
#raw : JSON::Type
Returns the raw underlying value, a JSON::Type.
#size : Int
Assumes the underlying value is an Array or Hash and returns its size.

Instance methods inherited from module `Enumerable(self)`

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Instance methods inherited from struct `Struct`

, , , ,

Instance methods inherited from struct `Value`

Instance methods inherited from class `Object`

, , , , , , , , , , , , , , , , , ,

Class methods inherited from class `Object`

Class Method Detail

def self.new(raw : JSON::Type)Source

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

def self.new(pull : JSON::PullParser)Source

Reads a JSON::Any value from the given pull parser-

Instance Method Detail

def ==(other)Source

Returns true if the raw object is equal to other.

def ==(other : JSON::Any)Source

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

def [](index : Int) : JSON::Any Source

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

def [](key : String) : JSON::Any Source

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

def []?(index : Int) : JSON::Any?Source

Assumes the underlying value is an Array and returns the element at the given index, or nil if out of bounds. Raises if the underlying value is not an Array.

def []?(key : String) : JSON::Any?Source

Assumes the underlying value is a Hash and returns the element with the given key, or nil if the key is not present. Raises if the underlying value is not a Hash.

def as_a : Array(Type)Source

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

def as_a? : Array(Type)?Source

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

def as_bool : Bool Source

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

def as_bool? : Bool?Source

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

def as_f : Float64 Source

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

def as_f32 : Float32 Source

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

def as_f32? : Float32?Source

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

def as_f? : Float64?Source

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

def as_h : Hash(String, Type)Source

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

def as_h? : Hash(String, Type)?Source

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

def as_i : Int32 Source

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

def as_i64 : Int64 Source

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

def as_i64? : Int64?Source

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

def as_i? : Int32?Source

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

def as_nil : Nil Source

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

def as_s : String Source

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

def as_s? : String?Source

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

def each(&block)Source

Assumes the underlying value is an Array or Hash and yields each of the elements or key/values, always as JSON::Any- Raises if the underlying value is not an Array or Hash.

def raw : JSON::Type Source

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

def size : Int Source

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

© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/JSON/Any.html