NAME

Data::Serializable - Moose role that adds serialization support to any class

VERSION

version 0.41.0

SYNOPSIS

    package MyClass;
    use Moose;
    with 'Data::Serializable';
    no Moose;

    package main;
    my $obj = MyClass->new( serializer_module => 'JSON' );
    my $json = $obj->serialize( "Foo" );
    ...
    my $str = $obj->deserialize( $json );

DESCRIPTION

A Moose-based role that enables the consumer to easily serialize/deserialize data structures. The default serializer is Storable, but any serializer in the Data::Serializer hierarchy can be used automatically. You can even install your own custom serializer if the pre-defined ones are not useful for you.

ATTRIBUTES

throws_exception

Defines if methods should throw exceptions or return undef. Default is to throw exceptions. Override default value like this:

    has '+throws_expection' => ( default => 0 );

serializer_module

Name of a predefined module that you wish to use for serialization. Any submodule of Data::Serializer is automatically supported. The built-in support for Storable doesn't require Data::Serializer.

serializer

If none of the predefined serializers work for you, you can install your own. This should be a code reference that takes one argument (the message to encode) and returns a scalar back to the caller with the serialized data.

deserializer

Same as serializer, but to decode the data.

METHODS

serialize($message)

Runs the serializer on the specified argument.

deserialize($message)

Runs the deserializer on the specified argument.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc Data::Serializable

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.

<http://metacpan.org/release/Data-Serializable>
Search CPAN
The default CPAN search engine, useful to view POD in HTML format.

<http://search.cpan.org/dist/Data-Serializable>
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Serializable>
AnnoCPAN
The AnnoCPAN is a website that allows community annotations of Perl module documentation.

<http://annocpan.org/dist/Data-Serializable>
CPAN Ratings
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

<http://cpanratings.perl.org/d/Data-Serializable>
CPAN Forum
The CPAN Forum is a web forum for discussing Perl modules.

<http://cpanforum.com/dist/Data-Serializable>
CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.perl.org/dist/overview/Data-Serializable>
CPAN Testers
The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/D/Data-Serializable>
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Data-Serializable>
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Data::Serializable>

Bugs / Feature Requests

Please report any bugs or feature requests by email to "bug-data-serializable at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Serializable>. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<http://github.com/robinsmidsrod/Data-Serializable>

  git clone git://github.com/robinsmidsrod/Data-Serializable.git

AUTHOR

Robin Smidsrød <robin@smidsrod.no>

COPYRIGHT AND LICENSE

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