File: README

package info (click to toggle)
libclass-field-perl 0.24-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 136 kB
  • sloc: perl: 138; makefile: 2
file content (79 lines) | stat: -rw-r--r-- 1,991 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
NAME

    Class::Field - Class Field Accessor Generator

VERSION

    This document describes Class::Field version 0.24.

SYNOPSIS

        package Thing;
        use Class::Field qw'field const';
    
        field 'this';
        field 'list' => [];
        field 'map' => {};
        field 'that', -init => '$self->setup_that';
        field 'circular_ref' => -weaken;
        const 'answer' => 42;

DESCRIPTION

    Class::Field exports two subroutines, field and const. These functions
    are used to declare fields and constants in your class.

    Class::Field generates custom code for each accessor that is optimized
    for speed.

FUNCTIONS

    field

      Defines accessor methods for a field of your class:

          package Example;
          use base 'Parent';
          use Class::Field qw'field const';
      
          field 'foo';
          field bar => [];
      
          sub lalala {
              my $self = shift;
              $self->foo(42);
              push @{$self->{bar}}, $self->foo;
          }

      The first parameter passed to field 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.

    const

          const bar => 42;

      The const 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 const a default value, otherwise the generated method will
      be somewhat useless.

NOTE

    This code was taken directly out the Spiffy module for those people who
    just want this functionality without using the rest of Spiffy.

AUTHOR

    Ingy döt Net <ingy@cpan.org>

COPYRIGHT AND LICENSE

    Copyright 2006-2019. Ingy döt Net.

    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

    See http://www.perl.com/perl/misc/Artistic.html