NAME

Data::AnyXfer::Elastic::Import::File::Format - Role representing an Elasticsearch import data storage format

SYNOPSIS

            

              
              
# data to printable characters
my $storable_output = $format->serialise($data);
# and back again
my $original_data = $format->deserialise($storable_output);
            
          

DESCRIPTION

This role is used by Data::AnyXfer::Elastic::Import::File and related modules to store and restore complex data.

Details of actual storage and persistence are handled by the Data::AnyXfer::Elastic::Import::Storage backend.

SEE ALSO

Data::AnyXfer::Elastic::Import::File, Data::AnyXfer::Elastic::Import::Storage

REQUIRED METHODS

serialise

            

              
              
# data to printable characters
my $storable_output = $format->serialise($data);
            
          

Serialise a perl data structure to printable characters / a storable representation (can also return binary data).

Should either succeed or die with errors.

deserialise

            

              
              
# and back again
my $original_data = $format->deserialise($storable_output);
            
          

De-serialise perl data from character or binary data back to the original data structure.

Should either succeed or die with errors.

OPTIONAL METHODS

format_suffix

A short slug or format name which can be used to identify this serialisation format

COPYRIGHT

This software is copyright (c) 2019, Anthony Lucas.

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