]>
Commit | Line | Data |
---|---|---|
f9995f31 MG |
1 | package IO::Uncompress::Brotli; |
2 | ||
3 | use 5.014000; | |
4 | use strict; | |
5 | use warnings; | |
6 | use parent qw/Exporter/; | |
7 | ||
8 | our @EXPORT = qw/unbro/; | |
9 | our @EXPORT_OK = @EXPORT; | |
10 | ||
b0ba4271 | 11 | our $VERSION = '0.002'; |
f9995f31 MG |
12 | |
13 | require XSLoader; | |
14 | XSLoader::load('IO::Compress::Brotli', $VERSION); | |
15 | ||
f9995f31 MG |
16 | 1; |
17 | __END__ | |
18 | ||
19 | =encoding utf-8 | |
20 | ||
21 | =head1 NAME | |
22 | ||
23 | IO::Uncompress::Brotli - Read Brotli buffers/streams | |
24 | ||
25 | =head1 SYNOPSIS | |
26 | ||
27 | use IO::Uncompress::Brotli; | |
28 | ||
29 | # uncompress a buffer | |
30 | my $decoded = unbro $encoded; | |
31 | ||
32 | # uncompress a stream | |
33 | my $bro = IO::Uncompress::Brotli->create; | |
34 | while(have_input()) { | |
35 | my $block = get_input_block(); | |
36 | my $decoded_block = $bro->decompress($block); | |
37 | handle_output_block($decoded_block); | |
38 | } | |
39 | ||
40 | =head1 DESCRIPTION | |
41 | ||
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. | |
46 | ||
47 | =head2 One-shot interface | |
48 | ||
49 | If you have the whole buffer in a Perl scalar use the B<unbro> | |
50 | function. | |
51 | ||
52 | =over | |
53 | ||
54 | =item B<unbro>(I<$input>) | |
55 | ||
56 | Takes a whole compressed buffer as input and returns the decompressed | |
57 | data. This function relies on the BrotliDecompressedSize function. In | |
58 | other words, it only works if the buffer has a single meta block or | |
59 | two meta-blocks where the first is uncompressed and the second is | |
60 | empty. | |
61 | ||
62 | Exported by default. | |
63 | ||
64 | =back | |
65 | ||
66 | =head2 Streaming interface | |
67 | ||
68 | If you want to process the data in blocks use the object oriented | |
69 | interface. The available methods are: | |
70 | ||
71 | =over | |
72 | ||
73 | =item IO::Uncompress::Brotli->B<create> | |
74 | ||
75 | Returns a IO::Uncompress::Brotli instance. Please note that a single | |
76 | instance cannot be used to decompress multiple streams. | |
77 | ||
78 | =item $bro->B<decompress>(I<$block>) | |
79 | ||
80 | Takes the a block of compressed data and returns a block of | |
81 | uncompressed data. Dies on error. | |
82 | ||
83 | =back | |
84 | ||
85 | =head1 SEE ALSO | |
86 | ||
87 | Brotli Compressed Data Format Internet-Draft: | |
88 | L<https://www.ietf.org/id/draft-alakuijala-brotli-08.txt> | |
89 | ||
90 | Brotli source code: L<https://github.com/google/brotli/> | |
91 | ||
92 | =head1 AUTHOR | |
93 | ||
94 | Marius Gavrilescu, E<lt>marius@ieval.roE<gt> | |
95 | ||
4c5aa4f8 MG |
96 | The encoder bindings, modernisation of the decoder bindings and a |
97 | clean up of the overall project were contributed by: | |
98 | ||
99 | =over | |
100 | ||
101 | =item Quim Rovira, E<lt>quim@rovira.catE<gt> | |
102 | ||
103 | =item Ævar Arnfjörð Bjarmason, E<lt>avarab@gmail.comE<gt> | |
104 | ||
105 | =item Marcell Szathmári | |
106 | ||
107 | =item Mattia Barbon, E<lt>mattia@barbon.orgE<gt> | |
108 | ||
f9995f31 MG |
109 | =head1 COPYRIGHT AND LICENSE |
110 | ||
b0ba4271 | 111 | Copyright (C) 2015-2016 by Marius Gavrilescu |
f9995f31 MG |
112 | |
113 | This library is free software; you can redistribute it and/or modify | |
114 | it under the same terms as Perl itself, either Perl version 5.20.2 or, | |
115 | at your option, any later version of Perl 5 you may have available. | |
116 | ||
117 | ||
118 | =cut |