W3cubDocs

/Ruby 4.0

class OpenStruct

Parent:: Object

Public Class Methods

# File ext/json/lib/json/add/ostruct.rb, line 13
def self.json_create(object)
  new(object['t'] || object[:t])
end

json_create (object) Show source

See as_json.

Public Instance Methods

# File ext/json/lib/json/add/ostruct.rb, line 33
def as_json(*)
  klass = self.class.name
  klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
  {
    JSON.create_id => klass,
    't'            => table,
  }
end

as_json (*) Show source

Methods OpenStruct#as_json and OpenStruct.json_create may be used to serialize and deserialize a OpenStruct object; see Marshal.

Method OpenStruct#as_json serializes self, returning a 2-element hash representing self:

require 'json/add/ostruct'
x = OpenStruct.new('name' => 'Rowdy', :age => nil).as_json
# => {"json_class"=>"OpenStruct", "t"=>{:name=>'Rowdy', :age=>nil}}

Method JSON.create deserializes such a hash, returning a OpenStruct object:

OpenStruct.json_create(x)
# => #<OpenStruct name='Rowdy', age=nil>

# File ext/json/lib/json/add/ostruct.rb, line 51
def to_json(*args)
  as_json.to_json(*args)
end

to_json (*args) Show source

Returns a JSON string representing self:

require 'json/add/ostruct'
puts OpenStruct.new('name' => 'Rowdy', :age => nil).to_json

Output:

{"json_class":"OpenStruct","t":{'name':'Rowdy',"age":null}}

Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.