libsereal-perl 4.005-1 / usr / share / perl5 / Sereal.pm

package Sereal;
use 5.008;
use strict;
use warnings;
our $VERSION = '4.005';
our $XS_VERSION = $VERSION; $VERSION= eval $VERSION;
use Sereal::Encoder 4.005 qw(encode_sereal sereal_encode_with_object);
use Sereal::Decoder 4.005 qw(
    decode_sereal looks_like_sereal decode_sereal_with_header_data
    scalar_looks_like_sereal
    sereal_decode_with_object sereal_decode_with_header_with_object
    sereal_decode_only_header_with_object
    sereal_decode_only_header_with_offset_with_object
    sereal_decode_with_header_and_offset_with_object
    sereal_decode_with_offset_with_object
);

use Exporter 'import';
our @EXPORT_OK = qw(
  get_sereal_decoder
  get_sereal_encoder
  clear_sereal_object_cache

  encode_sereal
  decode_sereal
  write_sereal
  read_sereal
  looks_like_sereal
  sereal_encode_with_object
  sereal_decode_with_object
  decode_sereal_with_header_data
  scalar_looks_like_sereal
  sereal_decode_with_header_with_object
  sereal_decode_only_header_with_object
  sereal_decode_only_header_with_offset_with_object
  sereal_decode_with_header_and_offset_with_object
  sereal_decode_with_offset_with_object
);
our %EXPORT_TAGS = (all => \@EXPORT_OK);
# export by default if run from command line
our @EXPORT = ((caller())[1] eq '-e' ? @EXPORT_OK : ());

our %ENCODERS;
our %DECODERS;

sub _key { join "\t", map { $_ => $_[0]->{$_} } sort keys %{$_[0]} }

sub clear_sereal_object_cache {
    %ENCODERS= ();
    %DECODERS= ();
}

sub get_sereal_encoder {
    my ($opts)= @_;
    return $ENCODERS{_key($opts)} ||= Sereal::Encoder->new($opts);
}

sub get_sereal_decoder {
    my ($opts)= @_;
    return $DECODERS{_key($opts)} ||= Sereal::Decoder->new($opts);
}

sub write_sereal_file {
    my ($file, $struct, $append, $opts)= @_;
    get_sereal_encoder($opts)->encode_to_file($file, $_[1], $append);
}

sub read_sereal_file {
    my ($file, $opts)= @_;
    get_sereal_decoder($opts)->decode_from_file($file,$_[2]);
}

1;

__END__

=encoding utf8

=head1 NAME

Sereal - Fast, compact, powerful binary (de-)serialization

=head1 SYNOPSIS

    use Sereal qw(
      get_sereal_decoder
      get_sereal_encoder
      clear_sereal_object_cache
      encode_sereal
      decode_sereal
      write_sereal
      read_sereal
      looks_like_sereal
      sereal_encode_with_object
      sereal_decode_with_object
      decode_sereal_with_header_data
      scalar_looks_like_sereal
      sereal_decode_with_header_with_object
      sereal_decode_only_header_with_object
      sereal_decode_only_header_with_offset_with_object
      sereal_decode_with_header_and_offset_with_object
      sereal_decode_with_offset_with_object
    );
    # Note: For performance reasons, you should prefer the OO interface,
    #       or sereal_(en|de)code_with_object over the stateless
    #       encode_sereal/decode_sereal functions.
    #       See the Sereal::Performance documentation for details.

=head1 DESCRIPTION

I<Sereal> is an efficient, compact-output, binary and feature-rich
serialization protocol. The Perl encoder is implemented as the
L<Sereal::Encoder> module, the Perl decoder correspondingly as
L<Sereal::Decoder>. They are distributed separately to allow for
safe upgrading without downtime. (Hint: Upgrade the decoder everywhere
first, then the encoder.)

This C<Sereal> module is a very thin wrapper around both C<Sereal::Encoder>
and C<Sereal::Decoder>. It depends on both and loads both. So if you have
a user of both encoder and decoder, it is enough to depend on a particular
version of C<Sereal> and you'll get the most recent released versions
of C<Sereal::Encoder> and C<Sereal::Decoder> whose version is smaller than
or equal to the version of C<Sereal> you depend on.

The protocol specification and many other bits of documentation
can be found in the github repository. Right now, the specification is at
L<https://github.com/Sereal/Sereal/blob/master/sereal_spec.pod>,
there is a discussion of the design objectives in
L<https://github.com/Sereal/Sereal/blob/master/README.pod>, and the output
of our benchmarks can be seen at
L<https://github.com/Sereal/Sereal/wiki/Sereal-Comparison-Graphs>.

=head2 EXPORTED FUNCTIONS

It is recommended to use the object-oriented interface of
C<Sereal::Encoder> and C<Sereal::Decoder> if you care about
performance. For detailed performance considerations,
see L<Sereal::Performance>.

You can optionally import five functions from C<Sereal>.
C<encode_sereal> is the same function as L<Sereal::Encoder>'s
C<encode_sereal> function. C<decode_sereal> and C<looks_like_sereal>
are the same as L<Sereal::Decoder>'s functions of the same names.
Finally, you can import the advanced functional interface
C<sereal_encode_with_object> and C<sereal_decode_with_object>.
Again, see L<Sereal::Performance> for information about those.

After loading the C<Sereal> module, both C<Sereal::Encoder> and
C<Sereal::Decoder> are guaranteed to be loaded, so you can use
their object-oriented interface.

=head2 get_sereal_encoder($OPTSHASH)

Returns a Sereal::Encoder with the given options. This encoder will be shared by other calls
to this function.

=head2 get_sereal_decoder($OPTSHASH)

Returns a Sereal::Decoder with the given options. This encoder will be shared by other calls
to this function.

=head2 write_sereal($FILENAME,$STRUCT,$APPEND,$OPTS)

Write a sereal packet to $FILENAME. See Sereal::Encoder::encode_to_file().

=head2 read_sereal($FILENAME,$OPTS)

Read a sereal packet from a file. See Sereal::Decoder::decode_from_file().

=head1 BUGS, CONTACT AND SUPPORT

For reporting bugs, please use the github bug tracker at
L<http://github.com/Sereal/Sereal/issues>.

For support and discussion of Sereal, there are two Google Groups:

Announcements around Sereal (extremely low volume):
L<https://groups.google.com/forum/?fromgroups#!forum/sereal-announce>

Sereal development list:
L<https://groups.google.com/forum/?fromgroups#!forum/sereal-dev>

=head1 AUTHOR

Steffen Mueller E<lt>smueller@cpan.orgE<gt>

=head1 ACKNOWLEDGMENT

This module was originally developed for Booking.com.
With approval from Booking.com, this module was generalized
and published on CPAN, for which the authors would like to express
their gratitude.

=head1 LICENSE

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

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2012, 2013, 2014 by Steffen Mueller

=cut