1Dpkg::Interface::Storable(3)     libdpkg-perl     Dpkg::Interface::Storable(3)
2
3
4

NAME

6       Dpkg::Interface::Storable - common methods related to object
7       serialization
8

DESCRIPTION

10       Dpkg::Interface::Storable is only meant to be used as parent class for
11       other objects. It provides common methods that are all implemented on
12       top of two basic methods parse() and output().
13

BASE METHODS

15       Those methods must be provided by the object that wish to inherit from
16       Dpkg::Interface::Storable so that the methods provided can work.
17
18       $obj->parse($fh, $desc)
19           This methods initialize the object with the data stored in the
20           filehandle. $desc is optional and is a textual description of the
21           filehandle used in error messages.
22
23       $string = $obj->output($fh)
24           This method returns a string representation of the object in
25           $string and it writes the same string to $fh (if it's defined).
26

PROVIDED METHODS

28       $obj->load($filename)
29           Initialize the object with the data stored in the file. The file
30           can be compressed, it will be uncompressed on the fly by using a
31           Dpkg::Compression::FileHandle object. If $filename is "-", then the
32           standard input is read (no compression is allowed in that case).
33
34       $obj->save($filename)
35           Store the object in the file. If the filename ends with a known
36           compression extension, it will be compressed on the fly by using a
37           Dpkg::Compression::FileHandle object. If $filename is "-", then the
38           standard output is used (data are written uncompressed in that
39           case).
40
41       "$obj"
42           Return a string representation of the object.
43

CHANGES

45   Version 1.00 (dpkg 1.15.6)
46       Mark the module as public.
47
48
49
501.18.25                           2018-06-26      Dpkg::Interface::Storable(3)