File Coverage

blib/lib/Kelp/Module/Sereal.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch			n/a
condition	2	4	50.0
subroutine	5	5	100.0
pod	3	3	100.0
total	26	28	92.8

$Kelp::Module::Sereal::VERSION = '1.02';
use Kelp::Base qw(Kelp::Module);
use Sereal qw(get_sereal_encoder get_sereal_decoder);

attr -encoder;
attr -decoder;

{
	my $self = shift;
	$self->encoder->encode(@_);
}

{
	my $self = shift;
	$self->decoder->decode(@_);
}

{
	my ($self, %args) = @_;

	my $encoder_opts = $args{encoder} // {};
	my $decoder_opts = $args{decoder} // {};

	$self->{encoder} = get_sereal_encoder($encoder_opts);
	$self->{decoder} = get_sereal_decoder($decoder_opts);

	$self->register(sereal => $self);
}

1;

=head1 NAME

Kelp::Module::Sereal - Sereal encoder / decoder for Kelp

=head1 SYNOPSIS

	# in config
	modules => [qw(Sereal)],
	modules_init => {
		Sereal => {
			encoder => {
				# encoder options
			},
			decoder => {
				# decoder options
			},
		},
	},

	# in your application
	my $encoded = $self->sereal->encode({
		type => 'structure',
		name => [qw(testing sereal)],
	});


=head1 DESCRIPTION

This is a very straightforward module that integrates the L<Kelp> framework with the L<Sereal> serialization protocol. See L<Sereal::Encoder> and L<Sereal::Decoder> for a full reference on the encoder and the decoder.

=head1 METHODS INTRODUCED TO KELP

=head2 sereal

	my $sereal_module = $kelp->sereal;

Returns the instance of this module. You can use this instance to invoke the methods listed below.

=head1 METHODS

=head2 encode

	my $encoded = $kelp->sereal->encode($data);

A shortcut to C<< $kelp->sereal->encoder->encode >>

=head2 encoder

	my $encoder_instance = $kelp->sereal->encoder;

Returns the instance of L<Sereal::Encoder>

=head2 decode

	my $decoded = $kelp->sereal->decode($sereal_string);

A shortcut to C<< $kelp->sereal->decoder->decode >>

=head2 decoder

	my $decoder_instance = $kelp->sereal->decoder;

Returns the instance of L<Sereal::Decoder>

=head1 CONFIGURATION

=head2 encoder

A hashref with all the arguments to L<Sereal::Encoder/new>.

=head2 decoder

A hashref with all the arguments to L<Sereal::Decoder/new>.

=head1 SEE ALSO

=over 2

=item * L<Kelp>, the framework

=item * L<Sereal>, the wrapper for the encoder / decoder

=back

=head1 AUTHOR

Bartosz Jarzyna, E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2021 - 2022 by Bartosz Jarzyna

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

=cut