Sebastian Nowicki > Text-TNetstrings > Text::TNetstrings

Download:
Text-TNetstrings-v1.2.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: v1.2.0   Source  

NAME ^

Text::TNetstrings - Data serialization using typed netstrings.

VERSION ^

Version 1.2.0

SYNOPSIS ^

An implementation of the tagged netstring specification, a simple data interchange format better suited to low-level network communication than JSON. See http://tnetstrings.org/ for more details.

        use Text::TNetstrings qw(:all);

        my $data = encode_tnetstrings({"foo" => "bar"}) # => "12:3:foo,3:bar,}"
        my $hash = decode_tnetstrings($data)            # => {"foo" => "bar"}

EXPORT ^

encode_tnetstrings($data)
decode_tnetstrings($data)
:all

The "all" tag exports all the above subroutines.

ENVIRONMENT ^

PERL_ONLY
TNETSTRINGS_PUREPERL

Can be set to a boolean value which controls whether the pure Perl implementation of Text::TNetstrings is used. The Text::TNetstrings module is a dual implementation, with all functionality written in both pure Perl and also in XS ('C'). By default, The XS version will be used whenever possible, as it is much faster. This option allows you to override the default behaviour.

TNETSTRINGS_XS

Unless TNETSTRINGS_PUREPERL or PERL_ONLY is set, an attempt will be made to load the XS module. If it can not be loaded it will fail quietly and fall back to the pure Perl module. If TNETSTRINGS_XS is set a warning will be issued if loading the XS module fails.

SUBROUTINES/METHODS ^

encode_tnetstrings($data)

Encode a scalar, hash or array into TNetstring format.

decode_tnetstrings($string)

Decode TNetstring data into the appropriate scalar, hash or array. In array context the remainder of the string will also be returned, e.g.:

        my ($data, $rest) = decode_tnetstrings("0:~foo"); #=> (undef, "foo")

MAPPING ^

Perl -> TNetstrings

ARRAY

Perl array references become TNetstring lists.

HASH

Perl hash references become TNetstring dictionaries. The TNetstring specification does not dictate an ordering, thus Perl's pseudo-random ordering is used.

Unblessed

Other unblessed references are not allowed, and an exception will be thrown. This uncludes CODEs, GLOBs, etc.

boolean::true, boolean::false

These special values become TNetstring true and false values, respectively.

Blessed Objects

Blessed objects are not representable in TNetstrings, and thus an exception will be thrown.

Scalars

Due to Perl not having distinct string, floating point or fixed point integers, the encoded type is a best guest. Undefined scalars will be encoded as TNetstring nulls (c<0:~>), values which look like a floating point number are encoded as floats, values which look like a fixed point integer are encoded as integers, and everything else is encoded as a string (using stringification).

AUTHOR ^

Sebastian Nowicki

SEE ALSO ^

http://tnetstrings.org/ for the TNetstrings specification.

Text::TNetStrings::XS for better performance.

Text::TNetStrings::PP if XS is not supported.

BUGS ^

Please report any bugs or feature requests to bug-data-tnetstrings at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-TNetstrings. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Text::TNetstrings

You can also look for information at:

CHANGES ^

v1.2.0

Support for encoding boolean objects.

v1.1.1

Performance improvements
Bug fixes for strings containing NULL bytes

v1.1.0

XS module for improved performance

v1.0.1

Performance improvements

v1.0.0

Initial release

LICENSE AND COPYRIGHT ^

Copyright 2011 Sebastian Nowicki.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

syntax highlighting: