Class OpenStruct
In: lib/ostruct.rb
Parent: Object

OpenStruct allows you to create data objects and set arbitrary attributes. For example: 

  require 'ostruct'

  record = OpenStruct.new
  record.name    = "John Smith"
  record.age     = 70
  record.pension = 300

  puts record.name     # -> "John Smith"
  puts record.address  # -> nil

It is like a hash with a different way to access the data. In fact, it is implemented with a hash, and you can initialize it with one. 

  hash = { "country" => "Australia", :population => 20_000_000 }
  data = OpenStruct.new(hash)

  p data        # -> <OpenStruct country="Australia" population=20000000>

Methods

==   delete_field   initialize_copy   inspect   marshal_dump   marshal_load   new   new_ostruct_member   to_s  

Public Class methods

new(hash=nil)

Create a new OpenStruct object. The optional hash, if given, will generate attributes and values. For example. 

  require 'ostruct'
  hash = { "country" => "Australia", :population => 20_000_000 }
  data = OpenStruct.new(hash)

  p data        # -> <OpenStruct country="Australia" population=20000000>

By default, the resulting OpenStruct object will have no attributes.

Public Instance methods

==(other)

Compare this object and other for equality.

delete_field(name)

Remove the named field from the object.

initialize_copy(orig)

Duplicate an OpenStruct object members.

inspect()

Returns a string containing a detailed summary of the keys and values.

to_s()

Alias for inspect

[Validate]

ruby-doc.org is a community service provided by Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.