Ruby 3.1 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Structクラス

class Struct

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

要約

構造体クラス。Struct.new はこのクラスのサブクラスを新たに生成します。

個々の構造体はサブクラスから Struct.new を使って生成します。個々の構造体サブクラスでは構造体のメンバに対するアクセスメソッドが定義されています。

特異メソッド

定義	説明
`new(args, keyword_init: nil) -> Class new(args, keyword_init: nil) {\|subclass\| block } -> Class`	Struct クラスに新しいサブクラスを作って、それを返します。
`new(args) -> Struct self[args] -> Struct`	(このメソッドは Struct の下位クラスにのみ定義されています) 構造体オブジェクトを生成して返します。
`keyword_init? -> bool \| nil`	(このメソッドは Struct の下位クラスにのみ定義されています) 構造体が作成されたときに keyword_init: true を指定されていたら true を返します。 false を指定されていたら false を返します。それ以外の場合は nil を返します。
`members -> [Symbol]`	(このメソッドは Struct の下位クラスにのみ定義されています) 構造体のメンバの名前(Symbol)の配列を返します。

インスタンスメソッド

定義	説明
`self == other -> bool`	self と other のクラスが同じであり、各メンバが == メソッドで比較して等しい場合に true を返します。そうでない場合に false を返します。
`self[member] -> object`	構造体のメンバの値を返します。
`self[member] = value`	構造体の member で指定されたメンバの値を value にして value を返します。
`values -> [object] to_a -> [object] deconstruct -> [object]`	構造体のメンバの値を配列にいれて返します。
`deconstruct_keys(array_of_names) -> Hash`	self のメンバの名前と値の組を Hash で返します。
`dig(key, ...) -> object \| nil`	self 以下のネストしたオブジェクトを dig メソッドで再帰的に参照して返します。途中のオブジェクトが nil であった場合は nil を返します。
`each {\|value\| ... } -> self each -> Enumerator`	構造体の各メンバに対して繰り返します。
`each_pair {\|member, value\| ... } -> self each_pair -> Enumerator`	構造体のメンバ名(Symbol)と値の組を引数にブロックを繰り返し実行します。
`eql?(other) -> bool`	self と other のクラスが同じであり、各メンバが eql? メソッドで比較して等しい場合に true を返します。そうでない場合に false を返します。
`equal?(other) -> bool`	指定された other が self 自身である場合のみ真を返します。これは Object クラスで定義されたデフォルトの動作です。
`select {\|i\| ... } -> [object] select -> Enumerator filter {\|i\| ... } -> [object] filter -> Enumerator`	構造体のメンバの値に対してブロックを評価した値が真であった要素を全て含む配列を返します。真になる要素がひとつもなかった場合は空の配列を返します。
`hash -> Integer`	self が保持するメンバのハッシュ値を元にして算出した整数を返します。 self が保持するメンバの値が変化すればこのメソッドが返す値も変化します。
`inspect -> String to_s -> String`	self の内容を人間に読みやすい文字列にして返します。
`length -> Integer size -> Integer`	構造体のメンバの数を返します。
`members -> [Symbol]`	構造体のメンバの名前(Symbol)の配列を返します。
`to_h -> Hash to_h {\|member, value\| block } -> Hash`	self のメンバ名(Symbol)と値の組を Hash にして返します。
`values_at(*members) -> [object]`	引数で指定されたメンバの値の配列を返します。

継承したメソッド

! != __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 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_ary to_hash to_int to_io to_proc to_regexp to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::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

追加されるメソッド

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