… | |
… | |
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. (JSON |
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 |
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). |
49 | data later you might want to compare both formats first). |
50 | |
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>. |
|
|
58 | |
51 | 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 |
52 | 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. |
53 | |
61 | |
54 | 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 |
55 | vice versa. |
63 | vice versa. |
… | |
… | |
58 | |
66 | |
59 | package CBOR::XS; |
67 | package CBOR::XS; |
60 | |
68 | |
61 | use common::sense; |
69 | use common::sense; |
62 | |
70 | |
63 | our $VERSION = 0.05; |
71 | our $VERSION = 0.07; |
64 | our @ISA = qw(Exporter); |
72 | our @ISA = qw(Exporter); |
65 | |
73 | |
66 | our @EXPORT = qw(encode_cbor decode_cbor); |
74 | our @EXPORT = qw(encode_cbor decode_cbor); |
67 | |
75 | |
68 | use Exporter; |
76 | use Exporter; |
… | |
… | |
283 | C<1>, which get turned into false and true in CBOR. |
291 | C<1>, which get turned into false and true in CBOR. |
284 | |
292 | |
285 | =item CBOR::XS::Tagged objects |
293 | =item CBOR::XS::Tagged objects |
286 | |
294 | |
287 | 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]> |
288 | 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 |
289 | 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. |
290 | |
299 | |
291 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
300 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
292 | |
301 | |
293 | These special values become CBOR true, CBOR false and CBOR undefined |
302 | These special values become CBOR true, CBOR false and CBOR undefined |
294 | 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 |
… | |
… | |
515 | |
524 | |
516 | sub CBOR::XS::Tagged::value { |
525 | sub CBOR::XS::Tagged::value { |
517 | $_[0][1] = $_[1] if $#_; |
526 | $_[0][1] = $_[1] if $#_; |
518 | $_[0][1] |
527 | $_[0][1] |
519 | } |
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]; |
520 | |
556 | |
521 | =head1 CBOR and JSON |
557 | =head1 CBOR and JSON |
522 | |
558 | |
523 | 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, |
524 | 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 |