class is serialized into a Perl HASH reference, it is tagged with the
class name and each instance attribute is stored. Very simple.
-This level is not optional, it is the bare minumum that
+This level is not optional, it is the bare minimum that
MooseX::Storage provides and all other levels build on top of this.
See L<MooseX::Storage::Basic> for the fundamental implementation and
This level is optional, if you don't want/need it, you don't have to
have it. You can just use C<pack>/C<unpack> instead.
+=for stopwords io
+
=item B<io>
The third (io) level is C<load> and C<store>. In this level we are reading
=item OnlyWhenBuilt
-Only attributes that have been built (ie, where the predicate returns
+Only attributes that have been built (i.e., where the predicate returns
'true') will be serialized. This avoids any potentially expensive computations.
See L<MooseX::Storage::Traits::OnlyWhenBuilt> for details.
With Array and Hash references the first level down is inspected and
any objects found are serialized/deserialized for you. We do not do
-this recusively by default, however this feature may become an
+this recursively by default, however this feature may become an
option eventually.
+=for stopwords subtypes
+
The specific serialize/deserialize routine is determined by the
Moose type constraint a specific attribute has. In most cases subtypes
of the supported types are handled correctly, and there is a facility
Storage(format => '=My::Private::JSONFormat');
+=for stopwords parameterized
+
To use a parameterized role (for which, see L<MooseX::Role::Parameterized>) you
can pass an arrayref of the role name (in short or long form, as above) and its
parameters:
=back
+=for stopwords TODO
+
=head1 TODO
This module needs docs and probably a Cookbook of some kind as well.
it under the same terms as Perl itself.
=cut
+
+
=head1 NAME
+=for stopwords undecisive
+
MooseX::Storage::Deferred - A role for undecisive programmers
=head1 SYNOPSIS
=item I<JSON>
+=for stopwords JSONpm
+
=item I<JSONpm>
=item I<YAML>
Sometimes you don't want a particular attribute to be part of the
serialization if it has not been built yet. If you invoke C<Storage()>
as outlined in the C<Synopsis>, only attributes that have been built
-(ie, where the predicate returns 'true') will be serialized.
+(i.e., where the predicate returns 'true') will be serialized.
This avoids any potentially expensive computations.
This trait is applied to an instance of L<MooseX::Storage::Engine>, for the
=head1 DESCRIPTION
+=for stopwords IPC
+
This module will C<thaw> and C<freeze> Moose classes using Storable. It
uses C<Storable::nfreeze> by default so that it can be easily used
in IPC scenarios across machines or just locally.
+=for stopwords Storable's
+
One important thing to note is that this module does not mix well
with the IO modules. The structures that C<freeze> and C<thaw> deal with
are Storable's memory representation, and (as far as I know) that
One important thing to note is that this module does not mix well
with the other Format modules. Since Storable serialized perl data
-structures in it's own format, those roles are lagely unnecessary.
+structures in it's own format, those roles are largely unnecessary.
However, there is always the possibility that having a set of
C<freeze/thaw> hooks can be useful, so because of that this module
=head1 DESCRIPTION
+=for stopwords culted
Sometimes you don't want a particular attribute to be part of the
serialization, in this case, you want to make sure that attribute
=head1 DESCRIPTION
+=for stopwords culted
+
Sometimes you don't want a particular attribute to be part of the
serialization, in this case, you want to make sure that attribute
uses this custom meta-attribute-trait. See the SYNOPSIS for a nice
This trait is applied to all objects that inherit from it. To use this
on a per-case basis, see C<disable_cycle_check> in L<MooseX::Storage::Basic>.
+=for stopwords culted
+
See the SYNOPSIS for a nice example that can be easily cargo-culted.
=head1 METHODS
Sometimes you don't want a particular attribute to be part of the
serialization if it has not been built yet. If you invoke C<Storage()>
as outlined in the C<Synopsis>, only attributes that have been built
-(ie, where the predicate returns 'true') will be serialized.
+(i.e., where the predicate returns 'true') will be serialized.
This avoids any potentially expensive computations.
+=for stopwords culted
+
See the SYNOPSIS for a nice example that can be easily cargo-culted.
=head1 METHODS
=head1 NAME
-MooseX::Storage::Util - A MooseX::Storage swiss-army chainsaw
+MooseX::Storage::Util - A MooseX::Storage Swiss Army chainsaw
=head1 DESCRIPTION
=back
+=for stopwords TODO
+
=head1 TODO
Add more stuff to this module :)
projects / gitmo/MooseX-Storage.git / commitdiff