.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "AnyEvent::Serialize 3pm"
.TH AnyEvent::Serialize 3pm "2021-01-08" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
AnyEvent::Serialize \- async serialize/deserialize function
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use AnyEvent::Serialize \*(Aq:all\*(Aq;
\&  use AnyEvent::Serialize \*(Aqserialize\*(Aq;
\&  use AnyEvent::Serialize \*(Aqdeserialize\*(Aq;
\&  use AnyEvent::Serialize ... block_size => 666;
\&
\&  serialize $object, sub { ($str, $recursion_detected) = @_ };
\&  deserialize $string, sub { my ($object, $error, $tail) = @_ }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sometimes You need to serialize/deserialize a lot of data. If You
do it using Data::Dumper or \fBeval\fR it can take You too much time.
This module splits (de)serialization process into fixed-size parts
and does this work in non-blocking mode.
.PP
This module uses Data::StreamSerializer and Data::StreamDeserializer
to serialize or deserialize Your data.
.SH "EXPORT"
.IX Header "EXPORT"
.ie n .SS "serialize($object, $result_callback)"
.el .SS "serialize($object, \f(CW$result_callback\fP)"
.IX Subsection "serialize($object, $result_callback)"
Serializes Your object. When serialization is done it will call
\&\fB\f(CB$result_callback\fB\fR. This callback receives two arguments:
.IP "result string" 4
.IX Item "result string"
.PD 0
.IP "flag if recursion is detected" 4
.IX Item "flag if recursion is detected"
.PD
.ie n .SS "deserialize($str, $result_callback)"
.el .SS "deserialize($str, \f(CW$result_callback\fP)"
.IX Subsection "deserialize($str, $result_callback)"
Deserializes Your string. When deserialization is done or an error is
detected it will call \fB\f(CB$result_callback\fB\fR. This callback receives three
arguments:
.IP "deserialized object" 4
.IX Item "deserialized object"
.PD 0
.IP "error string (if an error was occured)" 4
.IX Item "error string (if an error was occured)"
.IP "undeserialized string tail" 4
.IX Item "undeserialized string tail"
.PD
.SH "BREAKING"
.IX Header "BREAKING"
You can break serialization/deserialization process if You save value that
is returned by functions serialize/deserialize. They return guards
if they are called in non-void context.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Data::StreamSerializer, Data::StreamDeserializer.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dmitry E. Oboukhov, <unera@debian.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2011 by Dmitry E. Oboukhov
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.