… | |
… | |
26 | substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string |
26 | substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string |
27 | } |
27 | } |
28 | |
28 | |
29 | =head1 DESCRIPTION |
29 | =head1 DESCRIPTION |
30 | |
30 | |
31 | WARNING! THIS IS A PRE-ALPHA RELEASE! IT WILL CRASH, CORRUPT YOUR DATA |
31 | WARNING! This module is very new, and not very well tested (that's up to |
32 | AND EAT YOUR CHILDREN! (Actually, apart from being untested and a bit |
32 | you to do). Furthermore, details of the implementation might change freely |
33 | feature-limited, it might already be useful). |
33 | before version 1.0. And lastly, the object serialisation protocol depends |
|
|
34 | on a pending IANA assignment, and until that assignment is official, this |
|
|
35 | implementation is not interoperable with other implementations (even |
|
|
36 | future versions of this module) until the assignment is done. |
|
|
37 | |
|
|
38 | You are still invited to try out CBOR, and this module. |
34 | |
39 | |
35 | This module converts Perl data structures to the Concise Binary Object |
40 | This module converts Perl data structures to the Concise Binary Object |
36 | Representation (CBOR) and vice versa. CBOR is a fast binary serialisation |
41 | Representation (CBOR) and vice versa. CBOR is a fast binary serialisation |
37 | format that aims to use a superset of the JSON data model, i.e. when you |
42 | format that aims to use a superset of the JSON data model, i.e. when you |
38 | can represent something in JSON, you should be able to represent it in |
43 | can represent something in JSON, you should be able to represent it in |
39 | CBOR. |
44 | CBOR. |
40 | |
45 | |
41 | This makes it a faster and more compact binary alternative to JSON, with |
46 | In short, CBOR is a faster and very compact binary alternative to JSON, |
42 | the added ability of supporting serialising of perl objects. |
47 | with the added ability of supporting serialisation of Perl objects. (JSON |
|
|
48 | often compresses better than CBOR though, so if you plan to compress the |
|
|
49 | data later you might want to compare both formats first). |
43 | |
50 | |
44 | The primary goal of this module is to be I<correct> and the secondary goal |
51 | The primary goal of this module is to be I<correct> and the secondary goal |
45 | is to be I<fast>. To reach the latter goal it was written in C. |
52 | is to be I<fast>. To reach the latter goal it was written in C. |
46 | |
53 | |
47 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
54 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
… | |
… | |
51 | |
58 | |
52 | package CBOR::XS; |
59 | package CBOR::XS; |
53 | |
60 | |
54 | use common::sense; |
61 | use common::sense; |
55 | |
62 | |
56 | our $VERSION = 0.04; |
63 | our $VERSION = 0.05; |
57 | our @ISA = qw(Exporter); |
64 | our @ISA = qw(Exporter); |
58 | |
65 | |
59 | our @EXPORT = qw(encode_cbor decode_cbor); |
66 | our @EXPORT = qw(encode_cbor decode_cbor); |
60 | |
67 | |
61 | use Exporter; |
68 | use Exporter; |
… | |
… | |
222 | error). See the L<Types::Serialiser> manpage for details. |
229 | error). See the L<Types::Serialiser> manpage for details. |
223 | |
230 | |
224 | =item CBOR tag 256 (perl object) |
231 | =item CBOR tag 256 (perl object) |
225 | |
232 | |
226 | The tag value C<256> (TODO: pending iana registration) will be used |
233 | The tag value C<256> (TODO: pending iana registration) will be used |
227 | to deserialise a Perl object serialised with C<FREEZE>. See "OBJECT |
234 | to deserialise a Perl object serialised with C<FREEZE>. See L<OBJECT |
228 | SERIALISATION", below, for details. |
235 | SERIALISATION>, below, for details. |
229 | |
236 | |
230 | =item CBOR tag 55799 (magic header) |
237 | =item CBOR tag 55799 (magic header) |
231 | |
238 | |
232 | The tag 55799 is ignored (this tag implements the magic header). |
239 | The tag 55799 is ignored (this tag implements the magic header). |
233 | |
240 | |
… | |
… | |
288 | if you want. |
295 | if you want. |
289 | |
296 | |
290 | =item other blessed objects |
297 | =item other blessed objects |
291 | |
298 | |
292 | Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See |
299 | Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See |
293 | "OBJECT SERIALISATION", below, for details. |
300 | L<OBJECT SERIALISATION>, below, for details. |
294 | |
301 | |
295 | =item simple scalars |
302 | =item simple scalars |
296 | |
303 | |
297 | TODO |
304 | TODO |
298 | Simple Perl scalars (any scalar that is not a reference) are the most |
305 | Simple Perl scalars (any scalar that is not a reference) are the most |