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

class OpenStruct

クラスの継承リスト: OpenStruct < Object < Kernel

要約

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

OpenStruct のインスタンスに対して未定義なメソッド x= を呼ぶと、 OpenStruct クラスの Object#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>

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

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"]>

フリーズされている OpenStruct について

Ruby のバージョンごとに挙動が異なるので注意してください。以下のコードを実行した場合は、表のようになります。

require 'ostruct'
a = OpenStruct.new
a.x = :a
a.freeze
a.x = :b # この部分の挙動が異なる

1.8.0 再代入可能
1.8.1 TypeError
1.8.2 再代入可能
1.8.3 再代入可能
1.8.4 再代入可能
1.8.5 再代入可能
1.8.6 再代入可能
1.8.7 再代入可能
1.8.8 TypeError
1.9.1 再代入可能
1.9.2 TypeError

同様に以下のコードを実行した場合は全てのバージョンで例外が発生します。

require 'ostruct'
a = OpenStruct.new
a.x = :a
a.freeze
a.y = :b # TypeError

特異メソッド

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

インスタンスメソッド

定義	説明
`self == other -> bool`	自身と比較対象のオブジェクトが等しい場合に真を返します。そうでない場合は、偽を返します。
`delete_field(name) -> object`	nameで指定された要素を削除します。
`inspect -> String to_s -> String`	オブジェクトを人間が読める形式に変換した文字列を返します。
`new_ostruct_member(name) -> Symbol`	与えられた名前のアクセサメソッドを自身に定義します。

定数

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

継承したメソッド

=== =~ __id__ __send__ _dump class clone dclone display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method method_missing methods nil? pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods public_methods remove_instance_variable respond_to? singleton_method_added singleton_method_removed singleton_method_undefined singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_str to_yaml to_yaml_properties to_yaml_style untaint