make spelling tests pass
[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Meta / Attribute / Trait / DoNotSerialize.pm
1
2 package MooseX::Storage::Meta::Attribute::Trait::DoNotSerialize;
3 use Moose::Role;
4
5 # register this alias ...
6 package Moose::Meta::Attribute::Custom::Trait::DoNotSerialize;
7
8 sub register_implementation { 'MooseX::Storage::Meta::Attribute::Trait::DoNotSerialize' }
9
10 1;
11
12 __END__
13
14 =pod
15
16 =head1 NAME
17
18 MooseX::Storage::Meta::Attribute::Trait::DoNotSerialize - A custom meta-attribute-trait to bypass serialization
19
20 =head1 SYNOPSIS
21
22   package Point;
23   use Moose;
24   use MooseX::Storage;
25
26   with Storage('format' => 'JSON', 'io' => 'File');
27
28   has 'x' => (is => 'rw', isa => 'Int');
29   has 'y' => (is => 'rw', isa => 'Int');
30
31   has 'foo' => (
32       traits => [ 'DoNotSerialize' ],
33       is     => 'rw',
34       isa    => 'CodeRef',
35   );
36
37   1;
38
39 =head1 DESCRIPTION
40
41 =for stopwords culted
42
43 Sometimes you don't want a particular attribute to be part of the
44 serialization, in this case, you want to make sure that attribute
45 uses this custom meta-attribute-trait. See the SYNOPSIS for a nice
46 example that can be easily cargo-culted.
47
48 =head1 METHODS
49
50 =head2 Introspection
51
52 =over 4
53
54 =item B<meta>
55
56 =back
57
58 =head1 BUGS
59
60 All complex software has bugs lurking in it, and this module is no
61 exception. If you find a bug please either email me, or add the bug
62 to cpan-RT.
63
64 =head1 AUTHOR
65
66 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
67
68 =head1 COPYRIGHT AND LICENSE
69
70 Copyright 2007-2008 by Infinity Interactive, Inc.
71
72 L<http://www.iinteractive.com>
73
74 This library is free software; you can redistribute it and/or modify
75 it under the same terms as Perl itself.
76
77 =cut