lib/MooseX/Storage/Format/Storable.pm

   1 package MooseX::Storage::Format::Storable;
   2 use Moose::Role;
   3
   4 use Storable ();
   5
   6 requires 'pack';
   7 requires 'unpack';
   8
   9 sub thaw {
  10     my ( $class, $stored, @args ) = @_;
  11     $class->unpack( Storable::thaw($stored), @args );
  12 }
  13
  14 sub freeze {
  15     my ( $self, @args ) = @_;
  16     Storable::nfreeze( $self->pack(@args) );
  17 }
  18
  19 no Moose::Role;
  20
  21 1;
  22
  23 __END__
  24
  25 =pod
  26
  27 =head1 NAME
  28
  29 MooseX::Storage::Format::Storable - A Storable serialization role
  30
  31 =head1 SYNOPSIS
  32
  33   package Point;
  34   use Moose;
  35   use MooseX::Storage;
  36
  37   with Storage('format' => 'Storable');
  38
  39   has 'x' => (is => 'rw', isa => 'Int');
  40   has 'y' => (is => 'rw', isa => 'Int');
  41
  42   1;
  43
  44   my $p = Point->new(x => 10, y => 10);
  45
  46   ## methods to freeze/thaw into
  47   ## a specified serialization format
  48
  49   # pack the class with Storable
  50   my $storable_data = $p->freeze();
  51
  52   # unpack the storable data into the class
  53   my $p2 = Point->thaw($storable_data);
  54
  55 =head1 DESCRIPTION
  56
  57 =for stopwords IPC
  58
  59 This module will C<thaw> and C<freeze> Moose classes using Storable. It
  60 uses C<Storable::nfreeze> by default so that it can be easily used
  61 in IPC scenarios across machines or just locally.
  62
  63 =for stopwords Storable's
  64
  65 One important thing to note is that this module does not mix well
  66 with the IO modules. The structures that C<freeze> and C<thaw> deal with
  67 are Storable's memory representation, and (as far as I know) that
  68 is not easily just written onto a file. If you want file based
  69 serialization with Storable, the please look at the
  70 L<MooseX::Storage::IO::StorableFile> role instead.
  71
  72 =head1 METHODS
  73
  74 =over 4
  75
  76 =item B<freeze>
  77
  78 =item B<thaw ($stored)>
  79
  80 =back
  81
  82 =head2 Introspection
  83
  84 =over 4
  85
  86 =item B<meta>
  87
  88 =back
  89
  90 =head1 BUGS
  91
  92 All complex software has bugs lurking in it, and this module is no
  93 exception. If you find a bug please either email me, or add the bug
  94 to cpan-RT.
  95
  96 =head1 AUTHOR
  97
  98 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
  99
 100 =head1 COPYRIGHT AND LICENSE
 101
 102 Copyright 2007-2008 by Infinity Interactive, Inc.
 103
 104 L<http://www.iinteractive.com>
 105
 106 This library is free software; you can redistribute it and/or modify
 107 it under the same terms as Perl itself.
 108
 109 =cut
 110
 111