Current File : //proc/self/root/opt/cpanel/ea-ruby24/root/usr/share/ri/system/OpenStruct/cdesc-OpenStruct.ri
U:RDoc::NormalClass[iI"OpenStruct:ET@I" Object;To:RDoc::Markup::Document: @parts[o;;[ :
@fileI"%ext/json/lib/json/add/ostruct.rb;T:0@omit_headings_from_table_of_contents_below0o;;[o: RDoc::Markup::Paragraph;[ I"KAn OpenStruct is a data structure, similar to a Hash, that allows the ;TI"Pdefinition of arbitrary attributes with their accompanying values. This is ;TI"Qaccomplished by using Ruby's metaprogramming to define methods on the class ;TI" itself.;To: RDoc::Markup::BlankLine S:RDoc::Markup::Heading:
leveli: textI"
Examples;T@o:RDoc::Markup::Verbatim;[I"require "ostruct"
;TI"
;TI" person = OpenStruct.new
;TI" person.name = "John Smith"
;TI"person.age = 70
;TI"
;TI"(person.name # => "John Smith"
;TI" person.age # => 70
;TI" person.address # => nil
;T: @format0o; ;[I"PAn OpenStruct employs a Hash internally to store the attributes and values ;TI"*and can even be initialized with one:;T@o;;[I"Qaustralia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
;TI"B # => #<OpenStruct country="Australia", capital="Canberra">
;T;0o; ;[ I"MHash keys with spaces or characters that could normally not be used for ;TI"Nmethod calls (e.g. <code>()[]*</code>) will not be immediately available ;TI"Oon the OpenStruct object as a method for retrieval or assignment, but can ;TI"5still be reached through the Object#send method.;T@o;;[ I"?measurements = OpenStruct.new("length (in inches)" => 24)
;TI"7measurements.send("length (in inches)") # => 24
;TI"
;TI"0message = OpenStruct.new(:queued? => true)
;TI"9message.queued? # => true
;TI"%message.send("queued?=", false)
;TI":message.queued? # => false
;T;0o; ;[I"IRemoving the presence of an attribute requires the execution of the ;TI"Idelete_field method as setting the property value to +nil+ will not ;TI"remove the attribute.;T@o;;[I"Kfirst_pet = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
;TI"3second_pet = OpenStruct.new(:name => "Rowdy")
;TI"
;TI"first_pet.owner = nil
;TI"Jfirst_pet # => #<OpenStruct name="Rowdy", owner=nil>
;TI"*first_pet == second_pet # => false
;TI"
;TI"$first_pet.delete_field(:owner)
;TI"?first_pet # => #<OpenStruct name="Rowdy">
;TI")first_pet == second_pet # => true
;T;0S;
;i;I"Implementation;T@o; ;[I"RAn OpenStruct utilizes Ruby's method lookup structure to find and define the ;TI"Pnecessary methods for properties. This is accomplished through the methods ;TI"0method_missing and define_singleton_method.;T@o; ;[I"SThis should be a consideration if there is a concern about the performance of ;TI"Qthe objects that are created, as there is much more overhead in the setting ;TI">of these properties compared to using a Hash or a Struct.;T; I"lib/ostruct.rb;T;
0; 0;
0[ [ [ [[I"
class;T[[: public[[I"json_create;FI"%ext/json/lib/json/add/ostruct.rb;T[I"new;TI"lib/ostruct.rb;T[:protected[ [: private[ [I"
instance;T[[;[[I"==;T@g[I"[];F@g[I"[]=;F@g[I" as_json;F@d[I"delete_field;F@g[I"dig;F@g[I"each_pair;F@g[I" eql?;F@g[I" freeze;F@g[I" hash;F@g[I" inspect;F@g[I"marshal_dump;F@g[I"marshal_load;F@g[I" to_h;F@g[I" to_json;F@d[I" to_s;T@g[;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ; 0;
0[@
@X@XcRDoc::TopLevel
Mini Shell