NAME

Data::Embed::Util - embed arbitrary data in a file - utilities

DESCRIPTION

Accessor class for representing an embedded file (for reading).

FUNCTIONS

All these functions are not exported by default. You can use the following tags for importing them:

all

all of them

escaping

the escaping functions escape and unescape

constants

the two constants STARTER and TERMINATOR

escape

my $escaped = escape($input);

escape an input string. All alphanumeric characters, plus the underscore _, hyphen - and full stop . are preserved, while all the others are transformed into three-characters sequences %XX where XX are two hexadecimal digits.

STARTER

a string indicating the start of an index section

TERMINATOR

a string indicating the end of an index section

transfer

transfer($input_fh, $output_fh);

transfer data from an input filehandle to an output one.

unescape

my $raw = unescape($escaped);

unescape an input string with the reverse action performed by "escape".

AUTHOR

Flavio Poletti <polettix@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2014-2016 by Flavio Poletti <polettix@cpan.org>

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.