ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/CBOR-XS/XS.pm
(Generate patch)

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.8 by root, Sun Oct 27 22:48:12 2013 UTC vs.
Revision 1.18 by root, Sun Nov 17 05:26:14 2013 UTC

… …
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
31WARNING! THIS IS A PRE-ALPHA RELEASE! IT WILL CRASH, CORRUPT YOUR DATA 31WARNING! This module is very new, and not very well tested (that's up to
32AND EAT YOUR CHILDREN! (Actually, apart from being untested and a bit 32you to do). Furthermore, details of the implementation might change freely
33feature-limited, it might already be useful). 33before version 1.0. And lastly, the object serialisation protocol depends
34on a pending IANA assignment, and until that assignment is official, this
35implementation is not interoperable with other implementations (even
36future versions of this module) until the assignment is done.
37
38You are still invited to try out CBOR, and this module.
34 39
35This module converts Perl data structures to the Concise Binary Object 40This module converts Perl data structures to the Concise Binary Object
36Representation (CBOR) and vice versa. CBOR is a fast binary serialisation 41Representation (CBOR) and vice versa. CBOR is a fast binary serialisation
37format that aims to use a superset of the JSON data model, i.e. when you 42format that aims to use a superset of the JSON data model, i.e. when you
38can represent something in JSON, you should be able to represent it in 43can represent something in JSON, you should be able to represent it in
39CBOR. 44CBOR.
40 45
41This makes it a faster and more compact binary alternative to JSON, with 46In short, CBOR is a faster and very compact binary alternative to JSON,
42the added ability of supporting serialising of perl objects. 47with the added ability of supporting serialisation of Perl objects. (JSON
48often compresses better than CBOR though, so if you plan to compress the
49data later you might want to compare both formats first).
50
51To give you a general idea about speed, with texts in the megabyte range,
52C<CBOR::XS> usually encodes roughly twice as fast as L<Storable> or
53L<JSON::XS> and decodes about 15%-30% faster than those. The shorter the
54data, the worse L<Storable> performs in comparison.
55
56As for compactness, C<CBOR::XS> encoded data structures are usually about
5720% smaller than the same data encoded as (compact) JSON or L<Storable>.
43 58
44The primary goal of this module is to be I<correct> and the secondary goal 59The primary goal of this module is to be I<correct> and the secondary goal
45is to be I<fast>. To reach the latter goal it was written in C. 60is to be I<fast>. To reach the latter goal it was written in C.
46 61
47See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and 62See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and
… …
51 66
52package CBOR::XS; 67package CBOR::XS;
53 68
54use common::sense; 69use common::sense;
55 70
56our $VERSION = 0.04; 71our $VERSION = 0.08;
57our @ISA = qw(Exporter); 72our @ISA = qw(Exporter);
58 73
59our @EXPORT = qw(encode_cbor decode_cbor); 74our @EXPORT = qw(encode_cbor decode_cbor);
60 75
61use Exporter; 76use Exporter;
… …
222error). See the L<Types::Serialiser> manpage for details. 237error). See the L<Types::Serialiser> manpage for details.
223 238
224=item CBOR tag 256 (perl object) 239=item CBOR tag 256 (perl object)
225 240
226The tag value C<256> (TODO: pending iana registration) will be used 241The tag value C<256> (TODO: pending iana registration) will be used
227to deserialise a Perl object serialised with C<FREEZE>. See "OBJECT 242to deserialise a Perl object serialised with C<FREEZE>. See L<OBJECT
228SERIALISATION", below, for details. 243SERIALISATION>, below, for details.
229 244
230=item CBOR tag 55799 (magic header) 245=item CBOR tag 55799 (magic header)
231 246
232The tag 55799 is ignored (this tag implements the magic header). 247The tag 55799 is ignored (this tag implements the magic header).
233 248
… …
276C<1>, which get turned into false and true in CBOR. 291C<1>, which get turned into false and true in CBOR.
277 292
278=item CBOR::XS::Tagged objects 293=item CBOR::XS::Tagged objects
279 294
280Objects of this type must be arrays consisting of a single C<[tag, value]> 295Objects of this type must be arrays consisting of a single C<[tag, value]>
281pair. The (numerical) tag will be encoded as a CBOR tag, the value will be 296pair. The (numerical) tag will be encoded as a CBOR tag, the value will
282encoded as appropriate for the value. 297be encoded as appropriate for the value. You cna use C<CBOR::XS::tag> to
298create such objects.
283 299
284=item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error 300=item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error
285 301
286These special values become CBOR true, CBOR false and CBOR undefined 302These special values become CBOR true, CBOR false and CBOR undefined
287values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly 303values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly
288if you want. 304if you want.
289 305
290=item other blessed objects 306=item other blessed objects
291 307
292Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See 308Other blessed objects are serialised via C<TO_CBOR> or C<FREEZE>. See
293"OBJECT SERIALISATION", below, for details. 309L<OBJECT SERIALISATION>, below, for details.
294 310
295=item simple scalars 311=item simple scalars
296 312
297TODO 313TODO
298Simple Perl scalars (any scalar that is not a reference) are the most 314Simple Perl scalars (any scalar that is not a reference) are the most
… …
439=head1 MAGIC HEADER 455=head1 MAGIC HEADER
440 456
441There is no way to distinguish CBOR from other formats 457There is no way to distinguish CBOR from other formats
442programmatically. To make it easier to distinguish CBOR from other 458programmatically. To make it easier to distinguish CBOR from other
443formats, the CBOR specification has a special "magic string" that can be 459formats, the CBOR specification has a special "magic string" that can be
444prepended to any CBOR string without changing it's meaning. 460prepended to any CBOR string without changing its meaning.
445 461
446This string is available as C<$CBOR::XS::MAGIC>. This module does not 462This string is available as C<$CBOR::XS::MAGIC>. This module does not
447prepend this string tot he CBOR data it generates, but it will ignroe it 463prepend this string to the CBOR data it generates, but it will ignore it
448if present, so users can prepend this string as a "file type" indicator as 464if present, so users can prepend this string as a "file type" indicator as
449required. 465required.
450 466
467
468=head1 THE CBOR::XS::Tagged CLASS
469
470CBOR has the concept of tagged values - any CBOR value can be tagged with
471a numeric 64 bit number, which are centrally administered.
472
473C<CBOR::XS> handles a few tags internally when en- or decoding. You can
474also create tags yourself by encoding C<CBOR::XS::Tagged> objects, and the
475decoder will create C<CBOR::XS::Tagged> objects itself when it hits an
476unknown tag.
477
478These objects are simply blessed array references - the first member of
479the array being the numerical tag, the second being the value.
480
481You 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
487This function(!) creates a new C<CBOR::XS::Tagged> object using the given
488C<$tag> (0..2**64-1) to tag the given C<$value> (which can be any Perl
489value that can be encoded in CBOR, including serialisable Perl objects and
490C<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
500Access/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
510Access/mutate the tagged value.
511
512=back
513
514=cut
515
516sub tag($$) {
517 bless [@_], CBOR::XS::Tagged::;
518}
519
520sub CBOR::XS::Tagged::tag {
521 $_[0][0] = $_[1] if $#_;
522 $_[0][0]
523}
524
525sub CBOR::XS::Tagged::value {
526 $_[0][1] = $_[1] if $#_;
527 $_[0][1]
528}
529
530=head2 EXAMPLES
531
532Here are some examples of C<CBOR::XS::Tagged> uses to tag objects.
533
534You can look up CBOR tag value and emanings in the IANA registry at
535L<http://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml>.
536
537Prepend 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
543Serialise 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
551Wrap CBOR data in CBOR:
552
553 my $cbor_cbor = encode_cbor
554 CBOR::XS::tag 24,
555 encode_cbor [1, 2, 3];
451 556
452=head1 CBOR and JSON 557=head1 CBOR and JSON
453 558
454CBOR is supposed to implement a superset of the JSON data model, and is, 559CBOR is supposed to implement a superset of the JSON data model, and is,
455with some coercion, able to represent all JSON texts (something that other 560with some coercion, able to represent all JSON texts (something that other

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines