Class: ActionWebService::Struct

Class | ActionWebService::Struct
In: | lib/action_web_service/struct.rb
Parent: | Object

To send structured types across the wire, derive from ActionWebService::Struct, and use `member` to declare structure members.

ActionWebService::Struct should be used in method signatures when you want to accept or return structured types that have no Active Record model class representations, or you don’t want to expose your entire Active Record model to remote callers.

### Example

      class Person < ActionWebService::Struct
        member :id,         :int
        member :firstnames, [:string]
        member :lastname,   :string
        member :email,      :string
      end
      person = Person.new(:id => 5, :firstname => 'john', :lastname => 'doe')

Active Record model classes are already implicitly supported in method signatures.

### Methods

[] each_pair member new

### Included Modules

Reloadable::Subclasses

### Public Class methods

member(name, type)

Creates a structure member with the specified `name` and `type`. Generates accessor methods for reading and writing the member value.

new(values={})

If a Hash is given as argument to an ActionWebService::Struct constructor, it can contain initial values for the structure member.

### Public Instance methods

[](name)

The member with the given name

each_pair() {|name, self.__send__(name)| ...}

Iterates through each member

[Validate]