… | |
… | |
42 | 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 |
43 | 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 |
44 | CBOR. |
44 | CBOR. |
45 | |
45 | |
46 | In short, CBOR is a faster and very compact binary alternative to JSON, |
46 | In short, CBOR is a faster and very compact binary alternative to JSON, |
47 | with the added ability of supporting serialisation 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). |
|
|
50 | |
|
|
51 | To give you a general idea about speed, with texts in the megabyte range, |
|
|
52 | C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or |
|
|
53 | L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the |
|
|
54 | data, the worse L<Storable> performs in comparison. |
|
|
55 | |
|
|
56 | As for compactness, C<CBOR::XS> encoded data structures are usually about |
|
|
57 | 20% smaller than the same data encoded as (compact) JSON or L<Storable>. |
48 | |
58 | |
49 | The primary goal of this module is to be I<correct> and the secondary goal |
59 | The primary goal of this module is to be I<correct> and the secondary goal |
50 | is to be I<fast>. To reach the latter goal it was written in C. |
60 | is to be I<fast>. To reach the latter goal it was written in C. |
51 | |
61 | |
52 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
62 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
… | |
… | |
56 | |
66 | |
57 | package CBOR::XS; |
67 | package CBOR::XS; |
58 | |
68 | |
59 | use common::sense; |
69 | use common::sense; |
60 | |
70 | |
61 | our $VERSION = 0.05; |
71 | our $VERSION = 0.08; |
62 | our @ISA = qw(Exporter); |
72 | our @ISA = qw(Exporter); |
63 | |
73 | |
64 | our @EXPORT = qw(encode_cbor decode_cbor); |
74 | our @EXPORT = qw(encode_cbor decode_cbor); |
65 | |
75 | |
66 | use Exporter; |
76 | use Exporter; |
… | |
… | |
227 | error). See the L<Types::Serialiser> manpage for details. |
237 | error). See the L<Types::Serialiser> manpage for details. |
228 | |
238 | |
229 | =item CBOR tag 256 (perl object) |
239 | =item CBOR tag 256 (perl object) |
230 | |
240 | |
231 | The tag value C<256> (TODO: pending iana registration) will be used |
241 | The tag value C<256> (TODO: pending iana registration) will be used |
232 | to deserialise a Perl object serialised with C<FREEZE>. See "OBJECT |
242 | to deserialise a Perl object serialised with C<FREEZE>. See L<OBJECT |
233 | SERIALISATION", below, for details. |
243 | SERIALISATION>, below, for details. |
234 | |
244 | |
235 | =item CBOR tag 55799 (magic header) |
245 | =item CBOR tag 55799 (magic header) |
236 | |
246 | |
237 | The tag 55799 is ignored (this tag implements the magic header). |
247 | The tag 55799 is ignored (this tag implements the magic header). |
238 | |
248 | |
… | |
… | |
281 | C<1>, which get turned into false and true in CBOR. |
291 | C<1>, which get turned into false and true in CBOR. |
282 | |
292 | |
283 | =item CBOR::XS::Tagged objects |
293 | =item CBOR::XS::Tagged objects |
284 | |
294 | |
285 | Objects of this type must be arrays consisting of a single C<[tag, value]> |
295 | Objects of this type must be arrays consisting of a single C<[tag, value]> |
286 | pair. The (numerical) tag will be encoded as a CBOR tag, the value will be |
296 | pair. The (numerical) tag will be encoded as a CBOR tag, the value will |
287 | encoded as appropriate for the value. |
297 | be encoded as appropriate for the value. You cna use C<CBOR::XS::tag> to |
|
|
298 | create such objects. |
288 | |
299 | |
289 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
300 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
290 | |
301 | |
291 | These special values become CBOR true, CBOR false and CBOR undefined |
302 | These special values become CBOR true, CBOR false and CBOR undefined |
292 | values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly |
303 | values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly |
293 | if you want. |
304 | if you want. |
294 | |
305 | |
295 | =item other blessed objects |
306 | =item other blessed objects |
296 | |
307 | |
297 | Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See |
308 | Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See |
298 | "OBJECT SERIALISATION", below, for details. |
309 | L<OBJECT SERIALISATION>, below, for details. |
299 | |
310 | |
300 | =item simple scalars |
311 | =item simple scalars |
301 | |
312 | |
302 | TODO |
313 | TODO |
303 | Simple Perl scalars (any scalar that is not a reference) are the most |
314 | Simple Perl scalars (any scalar that is not a reference) are the most |
… | |
… | |
451 | This string is available as C<$CBOR::XS::MAGIC>. This module does not |
462 | This string is available as C<$CBOR::XS::MAGIC>. This module does not |
452 | prepend this string tot he CBOR data it generates, but it will ignroe it |
463 | prepend this string tot he CBOR data it generates, but it will ignroe it |
453 | if present, so users can prepend this string as a "file type" indicator as |
464 | if present, so users can prepend this string as a "file type" indicator as |
454 | required. |
465 | required. |
455 | |
466 | |
|
|
467 | |
|
|
468 | =head1 THE CBOR::XS::Tagged CLASS |
|
|
469 | |
|
|
470 | CBOR has the concept of tagged values - any CBOR value can be tagged with |
|
|
471 | a numeric 64 bit number, which are centrally administered. |
|
|
472 | |
|
|
473 | C<CBOR::XS> handles a few tags internally when en- or decoding. You can |
|
|
474 | also create tags yourself by encoding C<CBOR::XS::Tagged> objects, and the |
|
|
475 | decoder will create C<CBOR::XS::Tagged> objects itself when it hits an |
|
|
476 | unknown tag. |
|
|
477 | |
|
|
478 | These objects are simply blessed array references - the first member of |
|
|
479 | the array being the numerical tag, the second being the value. |
|
|
480 | |
|
|
481 | You can interact with C<CBOR::XS::Tagged> objects in the following ways: |
|
|
482 | |
|
|
483 | =over 4 |
|
|
484 | |
|
|
485 | =item $tagged = CBOR::XS::tag $tag, $value |
|
|
486 | |
|
|
487 | This function(!) creates a new C<CBOR::XS::Tagged> object using the given |
|
|
488 | C<$tag> (0..2**64-1) to tag the given C<$value> (which can be any Perl |
|
|
489 | value that can be encoded in CBOR, including serialisable Perl objects and |
|
|
490 | C<CBOR::XS::Tagged> objects). |
|
|
491 | |
|
|
492 | =item $tagged->[0] |
|
|
493 | |
|
|
494 | =item $tagged->[0] = $new_tag |
|
|
495 | |
|
|
496 | =item $tag = $tagged->tag |
|
|
497 | |
|
|
498 | =item $new_tag = $tagged->tag ($new_tag) |
|
|
499 | |
|
|
500 | Access/mutate the tag. |
|
|
501 | |
|
|
502 | =item $tagged->[1] |
|
|
503 | |
|
|
504 | =item $tagged->[1] = $new_value |
|
|
505 | |
|
|
506 | =item $value = $tagged->value |
|
|
507 | |
|
|
508 | =item $new_value = $tagged->value ($new_value) |
|
|
509 | |
|
|
510 | Access/mutate the tagged value. |
|
|
511 | |
|
|
512 | =back |
|
|
513 | |
|
|
514 | =cut |
|
|
515 | |
|
|
516 | sub tag($$) { |
|
|
517 | bless [@_], CBOR::XS::Tagged::; |
|
|
518 | } |
|
|
519 | |
|
|
520 | sub CBOR::XS::Tagged::tag { |
|
|
521 | $_[0][0] = $_[1] if $#_; |
|
|
522 | $_[0][0] |
|
|
523 | } |
|
|
524 | |
|
|
525 | sub CBOR::XS::Tagged::value { |
|
|
526 | $_[0][1] = $_[1] if $#_; |
|
|
527 | $_[0][1] |
|
|
528 | } |
|
|
529 | |
|
|
530 | =head2 EXAMPLES |
|
|
531 | |
|
|
532 | Here are some examples of C<CBOR::XS::Tagged> uses to tag objects. |
|
|
533 | |
|
|
534 | You can look up CBOR tag value and emanings in the IANA registry at |
|
|
535 | L<http://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml>. |
|
|
536 | |
|
|
537 | Prepend a magic header (C<$CBOR::XS::MAGIC>): |
|
|
538 | |
|
|
539 | my $cbor = encode_cbor CBOR::XS::tag 55799, $value; |
|
|
540 | # same as: |
|
|
541 | my $cbor = $CBOR::XS::MAGIC . encode_cbor $value; |
|
|
542 | |
|
|
543 | Serialise some URIs and a regex in an array: |
|
|
544 | |
|
|
545 | my $cbor = encode_cbor [ |
|
|
546 | (CBOR::XS::tag 32, "http://www.nethype.de/"), |
|
|
547 | (CBOR::XS::tag 32, "http://software.schmorp.de/"), |
|
|
548 | (CBOR::XS::tag 35, "^[Pp][Ee][Rr][lL]\$"), |
|
|
549 | ]; |
|
|
550 | |
|
|
551 | Wrap CBOR data in CBOR: |
|
|
552 | |
|
|
553 | my $cbor_cbor = encode_cbor |
|
|
554 | CBOR::XS::tag 24, |
|
|
555 | encode_cbor [1, 2, 3]; |
456 | |
556 | |
457 | =head1 CBOR and JSON |
557 | =head1 CBOR and JSON |
458 | |
558 | |
459 | CBOR is supposed to implement a superset of the JSON data model, and is, |
559 | CBOR is supposed to implement a superset of the JSON data model, and is, |
460 | with some coercion, able to represent all JSON texts (something that other |
560 | with some coercion, able to represent all JSON texts (something that other |