Class: Struct

Inherits:

Object

Object
Struct

show all

Includes:

Enumerable

Defined in:

struct.c

Overview

A Struct is a convenient way to bundle a number of attributes together, using accessor methods, without having to write an explicit class.

The Struct class is a generator of specific classes, each one of which is defined to hold a set of variables and their accessors. In these examples, we'll call the generated class "CustomerClass,'' and we'll show an example instance of that class as "CustomerInst.''

In the descriptions that follow, the parameter symbol refers to a symbol, which is either a quoted string or a Symbol (such as :name).

Class Method Summary (collapse)

+ (Object) new

Creates a new class, named by aString, containing accessor methods for the given symbols.

Instance Method Summary (collapse)

- (Boolean) ==(other_struct)

Equality---Returns true if other_struct is equal to this one: they must be of the same class as generated by Struct::new, and the values of all instance variables must be equal (according to Object#==).
- (Object) []

Attribute Reference---Returns the value of the instance variable named by symbol, or indexed (0..length-1) by fixnum.
- (Object) []=

Attribute Assignment---Assigns to the instance variable named by symbol or fixnum the value obj and returns it.
- (Object) each

Calls block once for each instance variable, passing the value as a parameter.
- (Object) each_pair

Calls block once for each instance variable, passing the name (as a symbol) and the value as parameters.
- (Object) eql?

code-seq:.
- (Fixnum) hash

Return a hash value based on this struct's contents.
- (Object) initialize constructor
- (Object) initialize_copy

:nodoc:.
- (Object) inspect (also: #to_s)

Describe the contents of this struct in a string.
- (Object) length

Returns the number of instance variables.
- (Array) members

Returns an array of strings representing the names of the instance variables.
- (Object) select

Invokes the block passing in successive elements from struct, returning an array containing those elements for which the block returns a true value (equivalent to Enumerable#select).
- (Object) size

Returns the number of instance variables.
- (Object) to_a

Returns the values for this instance as an array.
- (Object) values

Returns the values for this instance as an array.
- (Array) values_at(selector, ...)

Returns an array containing the elements in.

Methods included from Enumerable

#all?, #any?, #chunk, #collect, #collect_concat, #count, #cycle, #detect, #drop, #drop_while, #each_cons, #each_entry, #each_slice, #each_with_index, #each_with_object, #entries, #find, #find_all, #find_index, #first, #flat_map, #grep, #group_by, #include?, #inject, #map, #max, #max_by, #member?, #min, #min_by, #minmax, #minmax_by, #none?, #one?, #partition, #reduce, #reject, #reverse_each, #slice_before, #sort, #sort_by, #take, #take_while, #zip

Constructor Details

- (`Object`) initialize

# File 'struct.c'

static VALUE
rb_struct_initialize_m(int argc, VALUE *argv, VALUE self)
{
VALUE klass = rb_obj_class(self);
long n;

rb_struct_modify(self);
n = num_members(klass);
if (n < argc) {
rb_raise(rb_eArgError, "struct size differs");
}

Class Method Details

+ (`StructClass`) new([aString][, aSym]) + (`Object`) new(arg, ...) + (`Object`) [](arg, ...)

Creates a new class, named by aString, containing accessor methods for the given symbols. If the name aString is omitted, an anonymous structure class will be created. Otherwise, the name of this struct will appear as a constant in class Struct, so it must be unique for all Structs in the system and should start with a capital letter. Assigning a structure class to a constant effectively gives the class the name of the constant.

Struct::new returns a new Class object, which can then be used to create specific instances of the new structure. The number of actual parameters must be less than or equal to the number of attributes defined for this class; unset parameters default to nil. Passing too many parameters will raise an ArgumentError.

The remaining methods listed in this section (class and instance) are defined for this generated class.

# Create a structure with a name in Struct
Struct.new("Customer", :name, :address)    #=> Struct::Customer
Struct::Customer.new("Dave", "123 Main")   #=> #<struct Struct::Customer name="Dave", address="123 Main">

# Create a structure named by its constant
Customer = Struct.new(:name, :address)     #=> Customer
Customer.new("Dave", "123 Main")           #=> #<struct Customer name="Dave", address="123 Main">

Overloads:

+ (StructClass) new([aString][, aSym])
Returns:
- (StructClass)
+ (Object) new(arg, ...)
Returns:
- (Object)
+ (Object) [](arg, ...)
Returns:
- (Object)

# File 'struct.c'

static VALUE
rb_struct_s_def(int argc, VALUE *argv, VALUE klass)
{
VALUE name, rest;
long i;
VALUE st;
ID id;

rb_scan_args(argc, argv, "1*", &name, &rest);
if (!NIL_P(name) && SYMBOL_P(name)) {
rb_ary_unshift(rest, name);
name = Qnil;
}

Instance Method Details

- (`Boolean`) ==(other_struct)

Equality---Returns true if other_struct is equal to this one: they must be of the same class as generated by Struct::new, and the values of all instance variables must be equal (according to Object#==).

Customer = Struct.new(:name, :address, :zip)
joe   = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joejr = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
jane  = Customer.new("Jane Doe", "456 Elm, Anytown NC", 12345)
joe == joejr   #=> true
joe == jane    #=> false

Returns:

(Boolean)

# File 'struct.c'

static VALUE
rb_struct_equal(VALUE s, VALUE s2)
{
if (s == s2) return Qtrue;
if (TYPE(s2) != T_STRUCT) return Qfalse;
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
rb_bug("inconsistent struct"); /* should never happen */
}

- (`Object`) [](symbol) - (`Object`) [](fixnum)

Attribute Reference---Returns the value of the instance variable named by symbol, or indexed (0..length-1) by fixnum. Will raise NameError if the named variable does not exist, or IndexError if the index is out of range.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)

joe["name"]   #=> "Joe Smith"
joe[:name]    #=> "Joe Smith"
joe[0]        #=> "Joe Smith"

Overloads:

- (Object) [](symbol)
Returns:
- (Object)
- (Object) [](fixnum)
Returns:
- (Object)

# File 'struct.c'

VALUE
rb_struct_aref(VALUE s, VALUE idx)
{
long i;

if (TYPE(idx) == T_STRING || TYPE(idx) == T_SYMBOL) {
return rb_struct_aref_id(s, rb_to_id(idx));
}

- (`Object`) []=(symbol) - (`Object`) []=(fixnum)

Attribute Assignment---Assigns to the instance variable named by symbol or fixnum the value obj and returns it. Will raise a NameError if the named variable does not exist, or an IndexError if the index is out of range.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)

joe["name"] = "Luke"
joe[:zip]   = "90210"

joe.name   #=> "Luke"
joe.zip    #=> "90210"

Overloads:

- (Object) []=(symbol)
Returns:
- (Object)
- (Object) []=(fixnum)
Returns:
- (Object)

# File 'struct.c'

VALUE
rb_struct_aset(VALUE s, VALUE idx, VALUE val)
{
long i;

if (TYPE(idx) == T_STRING || TYPE(idx) == T_SYMBOL) {
return rb_struct_aset_id(s, rb_to_id(idx), val);
}

- (`Object`) each {|obj| ... } - (`Object`) each

Calls block once for each instance variable, passing the value as a parameter.

If no block is given, an enumerator is returned instead.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.each {|x| puts(x) }

produces:

Joe Smith
123 Maple, Anytown NC
12345

Overloads:

- (Object) each {|obj| ... }
Yields:
- (obj)

# File 'struct.c'

static VALUE
rb_struct_each(VALUE s)
{
long i;

RETURN_ENUMERATOR(s, 0, 0);
for (i=0; i<RSTRUCT_LEN(s); i++) {
rb_yield(RSTRUCT_PTR(s)[i]);
}

- (`Object`) each_pair {|sym, obj| ... } - (`Object`) each_pair

Calls block once for each instance variable, passing the name (as a symbol) and the value as parameters.

If no block is given, an enumerator is returned instead.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.each_pair {|name, value| puts("#{name} => #{value}") }

produces:

name => Joe Smith
address => 123 Maple, Anytown NC
zip => 12345

Overloads:

- (Object) each_pair {|sym, obj| ... }
Yields:
- (sym, obj)

# File 'struct.c'

static VALUE
rb_struct_each_pair(VALUE s)
{
VALUE members;
long i;

RETURN_ENUMERATOR(s, 0, 0);
members = rb_struct_members(s);
for (i=0; i<RSTRUCT_LEN(s); i++) {
rb_yield_values(2, rb_ary_entry(members, i), RSTRUCT_PTR(s)[i]);
}

- (`Object`) eql?

code-seq:

struct.eql?(other)   -> true or false

Two structures are equal if they are the same object, or if all their fields are equal (using eql?).

# File 'struct.c'

static VALUE
rb_struct_eql(VALUE s, VALUE s2)
{
if (s == s2) return Qtrue;
if (TYPE(s2) != T_STRUCT) return Qfalse;
if (rb_obj_class(s) != rb_obj_class(s2)) return Qfalse;
if (RSTRUCT_LEN(s) != RSTRUCT_LEN(s2)) {
rb_bug("inconsistent struct"); /* should never happen */
}

- (`Fixnum`) hash

Return a hash value based on this struct's contents.

Returns:

(Fixnum)

# File 'struct.c'

static VALUE
rb_struct_hash(VALUE s)
{
    return rb_exec_recursive_outer(recursive_hash, s, 0);
}

- (`Object`) initialize_copy

:nodoc:

# File 'struct.c'

VALUE
rb_struct_init_copy(VALUE copy, VALUE s)
{
if (copy == s) return copy;
rb_check_frozen(copy);
if (!rb_obj_is_instance_of(s, rb_obj_class(copy))) {
rb_raise(rb_eTypeError, "wrong argument class");
}

- (`String`) to_s - (`String`) inspect Also known as: to_s

Describe the contents of this struct in a string.

Overloads:

- (String) to_s
Returns:
- (String)
- (String) inspect
Returns:
- (String)

# File 'struct.c'

static VALUE
rb_struct_inspect(VALUE s)
{
    return rb_exec_recursive(inspect_struct, s, 0);
}

- (`Fixnum`) length - (`Fixnum`) size

Returns the number of instance variables.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.length   #=> 3

Overloads:

- (Fixnum) length
Returns:
- (Fixnum)
- (Fixnum) size
Returns:
- (Fixnum)

# File 'struct.c'

static VALUE
rb_struct_size(VALUE s)
{
    return LONG2FIX(RSTRUCT_LEN(s));
}

- (`Array`) members

Returns an array of strings representing the names of the instance variables.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.members   #=> [:name, :address, :zip]

Returns:

(Array)

# File 'struct.c'

static VALUE
rb_struct_members_m(VALUE obj)
{
    return rb_struct_s_members_m(rb_obj_class(obj));
}

- (`Array`) select {|i| ... } - (`Object`) select

Invokes the block passing in successive elements from struct, returning an array containing those elements for which the block returns a true value (equivalent to Enumerable#select).

Lots = Struct.new(:a, :b, :c, :d, :e, :f)
l = Lots.new(11, 22, 33, 44, 55, 66)
l.select {|v| (v % 2).zero? }   #=> [22, 44, 66]

Overloads:

- (Array) select {|i| ... }
Yields:
- (i)
Returns:
- (Array)

# File 'struct.c'

static VALUE
rb_struct_select(int argc, VALUE *argv, VALUE s)
{
VALUE result;
long i;

if (argc > 0) {
rb_raise(rb_eArgError, "wrong number of arguments (%d for 0)", argc);
}

- (`Fixnum`) length - (`Fixnum`) size

Returns the number of instance variables.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.length   #=> 3

Overloads:

- (Fixnum) length
Returns:
- (Fixnum)
- (Fixnum) size
Returns:
- (Fixnum)

# File 'struct.c'

static VALUE
rb_struct_size(VALUE s)
{
    return LONG2FIX(RSTRUCT_LEN(s));
}

- (`Array`) to_a - (`Array`) values

Returns the values for this instance as an array.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_a[1]   #=> "123 Maple, Anytown NC"

Overloads:

- (Array) to_a
Returns:
- (Array)
- (Array) values
Returns:
- (Array)

# File 'struct.c'

static VALUE
rb_struct_to_a(VALUE s)
{
    return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_PTR(s));
}

- (`Array`) to_a - (`Array`) values

Returns the values for this instance as an array.

Customer = Struct.new(:name, :address, :zip)
joe = Customer.new("Joe Smith", "123 Maple, Anytown NC", 12345)
joe.to_a[1]   #=> "123 Maple, Anytown NC"

Overloads:

- (Array) to_a
Returns:
- (Array)
- (Array) values
Returns:
- (Array)

# File 'struct.c'

static VALUE
rb_struct_to_a(VALUE s)
{
    return rb_ary_new4(RSTRUCT_LEN(s), RSTRUCT_PTR(s));
}

- (`Array`) values_at(selector, ...)

Returns an array containing the elements in

+self+ corresponding to the given selector(s). The selectors
may be either integer indices or ranges.
See also </code>.select<code>.

   a = %w{ a b c d e f }
   a.values_at(1, 3, 5)
   a.values_at(1, 3, 5, 7)
   a.values_at(-1, -3, -5, -7)
   a.values_at(1..3, 2...5)

Returns:

(Array)

# File 'struct.c'

static VALUE
rb_struct_values_at(int argc, VALUE *argv, VALUE s)
{
    return rb_get_values_at(s, RSTRUCT_LEN(s), argc, argv, struct_entry);
}

Class: Struct

Overview

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Enumerable

Constructor Details

- (Object) initialize

Class Method Details

+ (StructClass) new([aString][, aSym]) + (Object) new(arg, ...) + (Object) [](arg, ...)

Instance Method Details

- (Boolean) ==(other_struct)

- (Object) [](symbol) - (Object) [](fixnum)

- (Object) []=(symbol) - (Object) []=(fixnum)

- (Object) each {|obj| ... } - (Object) each

- (Object) each_pair {|sym, obj| ... } - (Object) each_pair

- (Object) eql?

- (Fixnum) hash

- (Object) initialize_copy

- (String) to_s - (String) inspect Also known as: to_s

- (Fixnum) length - (Fixnum) size

- (Array) members

- (Array) select {|i| ... } - (Object) select

- (Fixnum) length - (Fixnum) size

- (Array) to_a - (Array) values

- (Array) to_a - (Array) values

- (Array) values_at(selector, ...)

- (`Object`) initialize

+ (`StructClass`) new([aString][, aSym]) + (`Object`) new(arg, ...) + (`Object`) [](arg, ...)

- (`Boolean`) ==(other_struct)

- (`Object`) [](symbol) - (`Object`) [](fixnum)

- (`Object`) []=(symbol) - (`Object`) []=(fixnum)

- (`Object`) each {|obj| ... } - (`Object`) each

- (`Object`) each_pair {|sym, obj| ... } - (`Object`) each_pair

- (`Object`) eql?

- (`Fixnum`) hash

- (`Object`) initialize_copy

- (`String`) to_s - (`String`) inspect Also known as: to_s

- (`Fixnum`) length - (`Fixnum`) size

- (`Array`) members

- (`Array`) select {|i| ... } - (`Object`) select

- (`Fixnum`) length - (`Fixnum`) size

- (`Array`) to_a - (`Array`) values

- (`Array`) to_a - (`Array`) values

- (`Array`) values_at(selector, ...)