README
1NAME
2
3 POE::Filter::Bzip2 - A POE filter wrapped around Compress::Bzip2
4
5VERSION
6
7 version 1.60
8
9SYNOPSIS
10
11 use POE::Filter::Bzip2;
12
13 my $filter = POE::Filter::Bzip2->new();
14 my $scalar = 'Blah Blah Blah';
15 my $compressed_array = $filter->put( [ $scalar ] );
16 my $uncompressed_array = $filter->get( $compressed_array );
17
18 use POE qw(Filter::Stackable Filter::Line Filter::Bzip2);
19
20 my ($filter) = POE::Filter::Stackable->new();
21 $filter->push( POE::Filter::Bzip2->new(),
22 POE::Filter::Line->new( InputRegexp => '\015?\012', OutputLiteral => "\015\012" ),
23
24DESCRIPTION
25
26 POE::Filter::Bzip2 provides a POE filter for performing
27 compression/decompression using Compress::Bzip2. It is suitable for use
28 with POE::Filter::Stackable.
29
30CONSTRUCTOR
31
32 new
33
34 Creates a new POE::Filter::Bzip2 object. Takes one optional argument,
35 'level': the level of compression to employ. Consult Compress::Bzip2
36 for details.
37
38METHODS
39
40 get =item get_one =item get_one_start
41
42 Takes an arrayref which is contains lines of compressed input.
43 Returns an arrayref of decompressed lines.
44
45 put
46
47 Takes an arrayref containing lines of uncompressed output, returns an
48 arrayref of compressed lines.
49
50 clone
51
52 Makes a copy of the filter, and clears the copy's buffer.
53
54 level
55
56 Sets the level of compression employed to the given value. If no
57 value is supplied, returns the current level setting.
58
59SEE ALSO
60
61 POE
62
63 Compress::Bzip2
64
65 POE::Filter::Stackable
66
67AUTHOR
68
69 Chris Williams <chris@bingosnet.co.uk>
70
71COPYRIGHT AND LICENSE
72
73 This software is copyright (c) 2017 by Chris Williams.
74
75 This is free software; you can redistribute it and/or modify it under
76 the same terms as the Perl 5 programming language system itself.
77
78