File Coverage

blib/lib/Sereal/Dclone.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch	2	2	100.0
condition	2	3	66.6
subroutine	6	6	100.0
pod	1	1	100.0
total	32	33	96.9

package Sereal::Dclone;

use strict;
use warnings;
use Exporter 'import';
use Sereal::Decoder 'sereal_decode_with_object';
use Sereal::Encoder 'sereal_encode_with_object';

our $VERSION = '0.002';

our @EXPORT_OK = 'dclone';

my $decoder = Sereal::Decoder->new;
my $encoder = Sereal::Encoder->new({freeze_callbacks => 1, no_shared_hashkeys => 1});

sub dclone {
	my ($input, $options) = @_;
	my $enc;
	if ($options and keys %$options) {
		$enc = Sereal::Encoder->new({freeze_callbacks => 1, no_shared_hashkeys => 1, %$options});
	} else {
		$enc = $encoder;
	}
	return sereal_decode_with_object $decoder, sereal_encode_with_object $enc, $input;
}

1;

=head1 NAME

Sereal::Dclone - Deep (recursive) cloning via Sereal

=head1 SYNOPSIS

 use Sereal::Dclone 'dclone';
 my $cloned = dclone $ref;

=head1 DESCRIPTION

L provides a L function modeled after the function
from L, using L for fast serialization.

L is presently known to support serializing C, C,
C, C, and C references. L will also serialize and
recreate blessed objects, provided the underlying reference type is supported,
or the object class provides C and C serialization methods
(L). Be cautious with cloned
objects as only the internal data structure is cloned, and the destructor will
still be called when it is destroyed.

=head1 FUNCTIONS

L provides one function, which is exported on demand.

=head2 dclone

 my $cloned = dclone $ref;
 my $cloned = dclone $ref, {undef_unknown => 1, warn_unknown => 1};

Recursively clones a referenced data structure by serializing and then
deserializing it with L. Unlike L's dclone, the argument can
be any serializable scalar, not just a reference. If an unsupported value is
encountered, an exception will be thrown as it cannot be cloned.

Options can be passed to the underlying L object in an
optional hash reference. To prevent exceptions when serializing unsupported
values, the C or C options may be useful. The
C or C options can be used to control cloning
of objects. C is enabled by default.

=head1 BUGS

Report any issues on the public bugtracker.

=head1 AUTHOR

Dan Book

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Dan Book.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=head1 SEE ALSO

L, L