| … | |
… | |
| 13 | $original_data = decompress $compressed; |
13 | $original_data = decompress $compressed; |
| 14 | |
14 | |
| 15 | # import sfreeze, sfreeze_cref and sfreeze_c |
15 | # import sfreeze, sfreeze_cref and sfreeze_c |
| 16 | use Compress::LZF ':freeze'; |
16 | use Compress::LZF ':freeze'; |
| 17 | |
17 | |
| 18 | $compressed = sfreeze_c [4,5,6]; |
18 | $serialized = sfreeze_c [4,5,6]; |
| 19 | $original_data = sthaw $compressed; |
19 | $original_data = sthaw $serialized; |
| 20 | |
20 | |
| 21 | =head1 DESCRIPTION |
21 | =head1 DESCRIPTION |
| 22 | |
22 | |
| 23 | LZF is an extremely fast (not that much slower than a pure memcpy) |
23 | LZF is an extremely fast (not that much slower than a pure memcpy) |
| 24 | compression algorithm. It is ideal for applications where you want to save |
24 | compression algorithm. It is ideal for applications where you want to save |
| … | |
… | |
| 43 | =head2 $decompressed = decompress $compressed |
43 | =head2 $decompressed = decompress $compressed |
| 44 | |
44 | |
| 45 | Uncompress the string (compressed by C<compress>) and return the original |
45 | Uncompress the string (compressed by C<compress>) and return the original |
| 46 | data. Decompression errors can result in either broken data (there is no |
46 | data. Decompression errors can result in either broken data (there is no |
| 47 | checksum kept) or a runtime error. |
47 | checksum kept) or a runtime error. |
|
|
48 | |
|
|
49 | =head2 $serialized = sfreeze $value (simplified freeze) |
|
|
50 | |
|
|
51 | Often there is the need to serialize data into a string. This function does that, by using the Storable |
|
|
52 | module. It does the following transforms: |
|
|
53 | |
|
|
54 | IV, NV, PV (i.e. a _plain_ perl scalar): |
|
|
55 | => stays as is when it contains normal text/numbers |
|
|
56 | => gets serialized into a string |
|
|
57 | RV, undef, other funny objects (magical ones for example): |
|
|
58 | => data structure is freeze'd into a string. |
|
|
59 | |
|
|
60 | That is, it tries to leave "normal", human-readable data untouched but |
|
|
61 | still serializes complex data structures into strings. |
|
|
62 | |
|
|
63 | The idea of all these C<sfreeze> functions is to keep readability as high |
|
|
64 | as possible, and in cases readability can't be helped anyways, it tries to |
|
|
65 | compress the string. |
|
|
66 | |
|
|
67 | The C<sfreeze> functions will enlarge the original data one byte at most |
|
|
68 | and will only load the Storable method when neccessary. |
|
|
69 | |
|
|
70 | =head2 $serialized = sfreeze_c $value (sfreeze and compress) |
|
|
71 | |
|
|
72 | Similar to C<sfreeze>, but always tries to C<c>ompress the resulting |
|
|
73 | string. This still leaves most small objects (most numbers) untouched. |
|
|
74 | |
|
|
75 | =head2 $serialized = sfreeze_cr $value (sfreeze and compress references) |
|
|
76 | |
|
|
77 | Similar to C<sfreeze>, but tries to C<c>ompress the resulting string |
|
|
78 | unless it's a "simple" string. References for example are not "simple" and |
|
|
79 | as such are being compressed. |
|
|
80 | |
|
|
81 | =head2 $original_data = sthaw $serialized |
|
|
82 | |
|
|
83 | Recreate the original object from it's serialized representation. This |
|
|
84 | function automatically detects all the different sfreeze formats. |
| 48 | |
85 | |
| 49 | =head1 SEE ALSO |
86 | =head1 SEE ALSO |
| 50 | |
87 | |
| 51 | Other Compress::* modules, especially Compress::LZV1 (an older, less |
88 | Other Compress::* modules, especially Compress::LZV1 (an older, less |
| 52 | speedy module that guarentees only 1 byte overhead worst case) and |
89 | speedy module that guarentees only 1 byte overhead worst case) and |
