.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MakeMethods::Emulator::Struct 3pm"
.TH MakeMethods::Emulator::Struct 3pm "2016-06-10" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Class::MakeMethods::Emulator::Struct \- Emulate Class::Struct
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Class::MakeMethods::Emulator::Struct; 
\&  
\&  struct ( 
\&      simple  => \*(Aq$\*(Aq,
\&      ordered => \*(Aq@\*(Aq, 
\&      mapping => \*(Aq%\*(Aq,
\&      obj_ref => \*(AqFooObject\*(Aq 
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module emulates the functionality of Class::Struct by munging the provided field-declaration arguments to match those expected by Class::MakeMethods.
.PP
It supports the same four types of accessors, the choice of array-based or hash-based objects, and the choice of installing methods in the current package or a specified target.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
The below three declarations create equivalent methods for a simple hash-based class with a constructor and four accessors.
.PP
.Vb 7
\&  use Class::Struct;
\&  struct ( 
\&      simple  => \*(Aq$\*(Aq,
\&      ordered => \*(Aq@\*(Aq, 
\&      mapping => \*(Aq%\*(Aq,
\&      obj_ref => \*(AqFooObject\*(Aq 
\&  );
\&  
\&  use Class::MakeMethods::Emulator::Struct; 
\&  struct ( 
\&      simple  => \*(Aq$\*(Aq,
\&      ordered => \*(Aq@\*(Aq, 
\&      mapping => \*(Aq%\*(Aq,
\&      obj_ref => \*(AqFooObject\*(Aq 
\&    );
\&  
\&  use Class::MakeMethods ( 
\&      \-MakerClass               => \*(AqStandard::Array\*(Aq,
\&      \*(Aqnew\*(Aq                     => \*(Aqnew\*(Aq,
\&      \*(Aqscalar\*(Aq                  => \*(Aqsimple\*(Aq,
\&      \*(Aqarray \-auto_init 1\*(Aq      => \*(Aqordered\*(Aq, 
\&      \*(Aqhash \-auto_init 1\*(Aq       => \*(Aqmapping\*(Aq,
\&      \*(Aqobject \-auto_init 1\*(Aq     => \*(Aq\-class FooObject obj_ref\*(Aq 
\&    );
.Ve
.SH "COMPATIBILITY"
.IX Header "COMPATIBILITY"
This module aims to offer a \*(L"95% compatible\*(R" drop-in replacement for the core Class::Struct module for purposes of comparison and code migration.
.PP
The \f(CW\*(C`class\-struct.t\*(C'\fR test for the core Class::Struct module is included with this package. The test is unchanged except for the a direct substitution of this emulator's name in the place of the core module.
.PP
However, there are numerous internal differences between the methods generated by the original Class::Struct and this emulator, and some existing code may not work correctly without modification.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Class::MakeMethods for general information about this distribution.
.PP
See Class::MakeMethods::Emulator for more about this family of subclasses.
.PP
See Class::Struct for documentation of the original module.
.PP
See Class::MakeMethods::Standard::Hash and Class::MakeMethods::Standard::Array for documentation of the created methods.