.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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 "Class::Field 3pm"
.TH Class::Field 3pm "2019-02-13" "perl v5.28.1" "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::Field \- Class Field Accessor Generator
.SH "VERSION"
.IX Header "VERSION"
This document describes Class::Field version \fB0.24\fR.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package Thing;
\&    use Class::Field qw\*(Aqfield const\*(Aq;
\&
\&    field \*(Aqthis\*(Aq;
\&    field \*(Aqlist\*(Aq => [];
\&    field \*(Aqmap\*(Aq => {};
\&    field \*(Aqthat\*(Aq, \-init => \*(Aq$self\->setup_that\*(Aq;
\&    field \*(Aqcircular_ref\*(Aq => \-weaken;
\&    const \*(Aqanswer\*(Aq => 42;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class::Field exports two subroutines, \f(CW\*(C`field\*(C'\fR and \f(CW\*(C`const\*(C'\fR. These functions
are used to declare fields and constants in your class.
.PP
Class::Field generates custom code for each accessor that is optimized
for speed.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .IP """field""" 4
.el .IP "\f(CWfield\fR" 4
.IX Item "field"
Defines accessor methods for a field of your class:
.Sp
.Vb 3
\&    package Example;
\&    use base \*(AqParent\*(Aq;
\&    use Class::Field qw\*(Aqfield const\*(Aq;
\&
\&    field \*(Aqfoo\*(Aq;
\&    field bar => [];
\&
\&    sub lalala {
\&        my $self = shift;
\&        $self\->foo(42);
\&        push @{$self\->{bar}}, $self\->foo;
\&    }
.Ve
.Sp
The first parameter passed to \f(CW\*(C`field\*(C'\fR is the name of the attribute being
defined. Accessors can be given an optional default value. This value will be
returned if no value for the field has been set in the object.
.ie n .IP """const""" 4
.el .IP "\f(CWconst\fR" 4
.IX Item "const"
.Vb 1
\&    const bar => 42;
.Ve
.Sp
The \f(CW\*(C`const\*(C'\fR function is similar to <field> except that it is immutable.
It also does not store data in the object. You probably always want to
give a \f(CW\*(C`const\*(C'\fR a default value, otherwise the generated method will be
somewhat useless.
.SH "NOTE"
.IX Header "NOTE"
This code was taken directly out the Spiffy module for those people who just
want this functionality without using the rest of Spiffy.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ingy döt Net <ingy@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2019. Ingy döt Net.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>