Ruby 2.6.0 リファレンスマニュアル > ライブラリ一覧 > ostructライブラリ > OpenStructクラス

class OpenStruct

クラス・モジュールの継承リスト: OpenStruct < Object < Kernel < BasicObject

要約

要素を動的に追加・削除できる手軽な構造体を提供するクラスです。

OpenStruct のインスタンスに対して未定義なメソッド x= を呼ぶと、 OpenStruct クラスの BasicObject#method_missing で捕捉され、そのインスタンスにインスタンスメソッド x, x= が定義されます。この挙動によって要素を動的に変更できる構造体として働きます。

require 'ostruct'
ab = OpenStruct.new
ab.foo = 25
p ab.foo          # => 25
ab.bar = 2
p ab.bar          # => 2
p ab              # => <OpenStruct foo=25, bar=2>
ab.delete_field("foo")
p ab.foo          # => nil
p ab              # => <OpenStruct bar=2>

初期化にハッシュを使用することもできます。

require 'ostruct'
son = OpenStruct.new({ :name => "Thomas", :age => 3 })
p son.name        # => "Thomas"
p son.age         # => 3
son.age += 1
p son.age         # => 4
son.items = ["candy","toy"]
p son.items       # => ["candy","toy"]
p son             # => #<OpenStruct name="Thomas", age=4, items=["candy", "toy"]>

特異メソッド

定義	説明
`new(hash = nil) -> OpenStruct`	OpenStruct オブジェクトを生成します。

インスタンスメソッド

定義	説明
`self == other -> bool`	自身と比較対象のオブジェクトが等しい場合に真を返します。そうでない場合は、偽を返します。
`self[name] -> object`	引数 name で指定した要素に対応する値を返します。
`self[name] = value`	引数 name で指定した要素に対応する値に value をセットします。
`delete_field(name) -> object`	nameで指定された要素を削除します。
`dig(key, ...) -> object \| nil`	self 以下のネストしたオブジェクトを dig メソッドで再帰的に参照して返します。途中のオブジェクトが nil であった場合は nil を返します。
`each_pair -> Enumerator each_pair { \|key, value\| } -> self`	self の各要素の名前と要素を引数としてブロックを評価します。
`eql?(other) -> bool`	self と other が等しい場合に true を返します。そうでない場合は false を返します。
`hash -> Integer`	self のハッシュ値を返します。
`inspect -> String to_s -> String`	オブジェクトを人間が読める形式に変換した文字列を返します。
`to_h -> { Symbol => object } to_h {\|name, value\| block } -> Hash`	self を各要素の名前をキー(Symbol)、要素が値のハッシュに変換して返します。

protectedメソッド

定義	説明
`modifiable -> Hash`	このメソッドは内部的に使用されます。
`new_ostruct_member(name) -> Symbol`	与えられた名前のアクセサメソッドを自身に定義します。

定数

定義	説明
`InspectKey -> :__inspect_key__`	内部的に使用する定数です。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> === =~ _dump class clone define_singleton_method display enum_for equal? extend freeze frozen? initialize initialize_copy instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap then to_a to_ary to_hash to_int to_io to_proc to_regexp to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE

追加されるメソッド

定義	説明	ライブラリ
`json_create(hash) -> OpenStruct`	JSON のオブジェクトから OpenStruct のオブジェクトを生成して返します。	json/add/ostruct
`to_json(*args) -> String`	自身を JSON 形式の文字列に変換して返します。	json/add/ostruct