1PDF::API2::Basic::PDF::UFsielrteCro(n3t)ributed Perl DocPuDmFe:n:tAaPtIi2o:n:Basic::PDF::Filter(3)
2
3
4

NAME

6       PDF::API2::Basic::PDF::Filter - Abstract superclass for PDF stream
7       filters
8

SYNOPSIS

10           $f = PDF::API2::Basic::PDF::Filter->new;
11           $str = $f->outfilt($str, 1);
12           print OUTFILE $str;
13
14           while (read(INFILE, $dat, 4096))
15           { $store .= $f->infilt($dat, 0); }
16           $store .= $f->infilt("", 1);
17

DESCRIPTION

19       A Filter object contains state information for the process of
20       outputting and inputting data through the filter. The precise state
21       information stored is up to the particular filter and may range from
22       nothing to whole objects created and destroyed.
23
24       Each filter stores different state information for input and output and
25       thus may handle one input filtering process and one output filtering
26       process at the same time.
27

METHODS

29   PDF::API2::Basic::PDF::Filter->new
30       Creates a new filter object with empty state information ready for
31       processing data both input and output.
32
33   $dat = $f->infilt($str, $isend)
34       Filters from output to input the data. Notice that $isend == 0 implies
35       that there is more data to come and so following it $f may contain
36       state information (usually due to the break-off point of $str not being
37       tidy). Subsequent calls will incorporate this stored state information.
38
39       $isend == 1 implies that there is no more data to follow. The final
40       state of $f will be that the state information is empty. Error messages
41       are most likely to occur here since if there is required state
42       information to be stored following this data, then that would imply an
43       error in the data.
44
45   $str = $f->outfilt($dat, $isend)
46       Filter stored data ready for output. Parallels "infilt".
47
48
49
50perl v5.32.1                      2021-04-14  PDF::API2::Basic::PDF::Filter(3)
Impressum