1 package IO
::Uncompress
::Brotli
;
6 use parent qw
/Exporter/;
8 our @EXPORT = qw
/unbro/;
9 our @EXPORT_OK = @EXPORT;
11 our $VERSION = '0.003';
14 XSLoader
::load
('IO::Compress::Brotli', $VERSION);
23 IO::Uncompress::Brotli - Read Brotli buffers/streams
27 use IO::Uncompress::Brotli;
29 # uncompress a buffer (yielding at most 10MB)
30 my $decoded = unbro $encoded, 10_000_000;
33 my $bro = IO::Uncompress::Brotli->create;
35 my $block = get_input_block();
36 my $decoded_block = $bro->decompress($block);
37 handle_output_block($decoded_block);
42 IO::Uncompress::Brotli is a module that decompresses Brotli buffers
43 and streams. Despite its name, it is not a subclass of
44 L<IO::Uncompress::Base> and does not implement its interface. This
45 will be rectified in a future release.
47 =head2 One-shot interface
49 If you have the whole buffer in a Perl scalar use the B<unbro>
54 =item B<unbro>(I<$input>, I<$maximum_decoded_size>)
56 Takes a whole compressed buffer as input and returns the decompressed
57 data. It allocates a buffer of size I<$maximum_decoded_size> to store
58 the decompressed data, if this is not sufficient (or there is another
59 error) this function will croak.
65 =head2 Streaming interface
67 If you want to process the data in blocks use the object oriented
68 interface. The available methods are:
72 =item IO::Uncompress::Brotli->B<create>
74 Returns a IO::Uncompress::Brotli instance. Please note that a single
75 instance cannot be used to decompress multiple streams.
77 =item $bro->B<decompress>(I<$block>)
79 Takes the a block of compressed data and returns a block of
80 uncompressed data. Dies on error.
86 Brotli Compressed Data Format Internet-Draft:
87 L<https://www.ietf.org/id/draft-alakuijala-brotli-08.txt>
89 Brotli source code: L<https://github.com/google/brotli/>
93 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
95 The encoder bindings, modernisation of the decoder bindings and a
96 clean up of the overall project were contributed by:
100 =item Quim Rovira, E<lt>quim@rovira.catE<gt>
102 =item Ævar Arnfjörð Bjarmason, E<lt>avarab@gmail.comE<gt>
104 =item Marcell Szathmári
106 =item Mattia Barbon, E<lt>mattia@barbon.orgE<gt>
110 =head1 COPYRIGHT AND LICENSE
112 Copyright (C) 2015-2017 by Marius Gavrilescu
114 This library is free software; you can redistribute it and/or modify
115 it under the same terms as Perl itself, either Perl version 5.20.2 or,
116 at your option, any later version of Perl 5 you may have available.
This page took 0.026085 seconds and 4 git commands to generate.