README
1NAME
2 Data::Serializable - Moose role that adds serialization support to any
3 class
4
5VERSION
6 version 0.41.0
7
8SYNOPSIS
9 package MyClass;
10 use Moose;
11 with 'Data::Serializable';
12 no Moose;
13
14 package main;
15 my $obj = MyClass->new( serializer_module => 'JSON' );
16 my $json = $obj->serialize( "Foo" );
17 ...
18 my $str = $obj->deserialize( $json );
19
20DESCRIPTION
21 A Moose-based role that enables the consumer to easily
22 serialize/deserialize data structures. The default serializer is
23 Storable, but any serializer in the Data::Serializer hierarchy can be
24 used automatically. You can even install your own custom serializer if
25 the pre-defined ones are not useful for you.
26
27ATTRIBUTES
28 throws_exception
29 Defines if methods should throw exceptions or return undef. Default is
30 to throw exceptions. Override default value like this:
31
32 has '+throws_expection' => ( default => 0 );
33
34 serializer_module
35 Name of a predefined module that you wish to use for serialization. Any
36 submodule of Data::Serializer is automatically supported. The built-in
37 support for Storable doesn't require Data::Serializer.
38
39 serializer
40 If none of the predefined serializers work for you, you can install your
41 own. This should be a code reference that takes one argument (the
42 message to encode) and returns a scalar back to the caller with the
43 serialized data.
44
45 deserializer
46 Same as serializer, but to decode the data.
47
48METHODS
49 serialize($message)
50 Runs the serializer on the specified argument.
51
52 deserialize($message)
53 Runs the deserializer on the specified argument.
54
55SEE ALSO
56 * Moose::Manual::Roles
57
58 * Data::Serializer
59
60SUPPORT
61 Perldoc
62 You can find documentation for this module with the perldoc command.
63
64 perldoc Data::Serializable
65
66 Websites
67 The following websites have more information about this module, and may
68 be of help to you. As always, in addition to those websites please use
69 your favorite search engine to discover more resources.
70
71 * MetaCPAN
72
73 A modern, open-source CPAN search engine, useful to view POD in HTML
74 format.
75
76 <http://metacpan.org/release/Data-Serializable>
77
78 * Search CPAN
79
80 The default CPAN search engine, useful to view POD in HTML format.
81
82 <http://search.cpan.org/dist/Data-Serializable>
83
84 * RT: CPAN's Bug Tracker
85
86 The RT ( Request Tracker ) website is the default bug/issue tracking
87 system for CPAN.
88
89 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Data-Serializable>
90
91 * AnnoCPAN
92
93 The AnnoCPAN is a website that allows community annotations of Perl
94 module documentation.
95
96 <http://annocpan.org/dist/Data-Serializable>
97
98 * CPAN Ratings
99
100 The CPAN Ratings is a website that allows community ratings and
101 reviews of Perl modules.
102
103 <http://cpanratings.perl.org/d/Data-Serializable>
104
105 * CPAN Forum
106
107 The CPAN Forum is a web forum for discussing Perl modules.
108
109 <http://cpanforum.com/dist/Data-Serializable>
110
111 * CPANTS
112
113 The CPANTS is a website that analyzes the Kwalitee ( code metrics )
114 of a distribution.
115
116 <http://cpants.perl.org/dist/overview/Data-Serializable>
117
118 * CPAN Testers
119
120 The CPAN Testers is a network of smokers who run automated tests on
121 uploaded CPAN distributions.
122
123 <http://www.cpantesters.org/distro/D/Data-Serializable>
124
125 * CPAN Testers Matrix
126
127 The CPAN Testers Matrix is a website that provides a visual overview
128 of the test results for a distribution on various Perls/platforms.
129
130 <http://matrix.cpantesters.org/?dist=Data-Serializable>
131
132 * CPAN Testers Dependencies
133
134 The CPAN Testers Dependencies is a website that shows a chart of the
135 test results of all dependencies for a distribution.
136
137 <http://deps.cpantesters.org/?module=Data::Serializable>
138
139 Bugs / Feature Requests
140 Please report any bugs or feature requests by email to
141 "bug-data-serializable at rt.cpan.org", or through the web interface at
142 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Data-Serializable>. You
143 will be automatically notified of any progress on the request by the
144 system.
145
146 Source Code
147 The code is open to the world, and available for you to hack on. Please
148 feel free to browse it and play with it, or whatever. If you want to
149 contribute patches, please send me a diff or prod me to pull from your
150 repository :)
151
152 <http://github.com/robinsmidsrod/Data-Serializable>
153
154 git clone git://github.com/robinsmidsrod/Data-Serializable.git
155
156AUTHOR
157 Robin Smidsrød <robin@smidsrod.no>
158
159COPYRIGHT AND LICENSE
160 This software is copyright (c) 2013 by Robin Smidsrød.
161
162 This is free software; you can redistribute it and/or modify it under
163 the same terms as the Perl 5 programming language system itself.
164
165