/ 
Compress-Snappy-0.11_3
River stage one • 4 direct dependents • 8 total dependents
/ Compress::Snappy

NAME

Compress::Snappy - Perl interface to Google's Snappy (de)compressor

SYNOPSIS

use Compress::Snappy;

my $dest = compress($source);
my $dest = decompress($source);

DESCRIPTION

The Compress::Snappy module provides an interface to Google's Snappy (de)compressor.

Snappy does not aim for maximum compression, or compatibility with any other compression library; instead, it aims for very high speeds and reasonable compression. For instance, compared to the fastest mode of zlib, Snappy is an order of magnitude faster for most inputs, but the resulting compressed files are anywhere from 20% to 100% bigger.

FUNCTIONS

compress

$string = compress($buffer)

Compresses the given buffer and returns the resulting string. The input buffer can be either a scalar or a scalar reference.

decompress

uncompress

$string = decompress($buffer)

Decompresses the given buffer and returns the resulting string. The input buffer can be either a scalar or a scalar reference.

On error (in case of corrupted data) undef is returned.

PERFORMANCE

This distribution contains a benchmarking script which compares serveral compression modules available on CPAN. These are the results on a MacBook 2GHz Core 2 Duo (64-bit) with Perl 5.12.3:

Compressible data (10 KiB) - compression
----------------------------------------
Compress::Snappy::compress  139183/s  1359 MiB/s
Compress::LZF::compress      43115/s   421 MiB/s
Compress::Bzip2::compress     5332/s    52 MiB/s
Compress::Zlib::compress      3054/s    30 MiB/s

Compressible data (10 KiB) - decompression
------------------------------------------
Compress::Snappy::decompress  128478/s  1255 MiB/s
Compress::LZF::decompress      37594/s   367 MiB/s
Compress::Bzip2::decompress    17596/s   172 MiB/s
Compress::Zlib::uncompress      5288/s    52 MiB/s

Uncompressible data (10 KiB) - compression
------------------------------------------
Compress::Snappy::compress  1485435/s  14506 MiB/s
Compress::LZF::compress      594752/s   5808 MiB/s
Compress::Bzip2::compress     15360/s    150 MiB/s
Compress::Zlib::compress       4479/s     44 MiB/s

Uncompressible data (10 KiB) - decompression
--------------------------------------------
Compress::LZF::decompress     2858267/s  27913 MiB/s
Compress::Snappy::decompress  2502283/s  24436 MiB/s
Compress::Bzip2::decompress     53096/s    519 MiB/s
Compress::Zlib::uncompress       6637/s     65 MiB/s

SEE ALSO

http://code.google.com/p/snappy/

https://github.com/zeevt/csnappy

REQUESTS AND BUGS

Please report any bugs or feature requests to http://rt.cpan.org/Public/Bug/Report.html?Queue=Compress-Snappy. 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 Compress::Snappy

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright (C) 2011 gray <gray at cpan.org>, all rights reserved.

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

AUTHOR

gray, <gray at cpan.org>