| … | |
… | |
| 58 | |
58 | |
| 59 | package CBOR::XS; |
59 | package CBOR::XS; |
| 60 | |
60 | |
| 61 | use common::sense; |
61 | use common::sense; |
| 62 | |
62 | |
| 63 | our $VERSION = 0.05; |
63 | our $VERSION = 0.06; |
| 64 | our @ISA = qw(Exporter); |
64 | our @ISA = qw(Exporter); |
| 65 | |
65 | |
| 66 | our @EXPORT = qw(encode_cbor decode_cbor); |
66 | our @EXPORT = qw(encode_cbor decode_cbor); |
| 67 | |
67 | |
| 68 | use Exporter; |
68 | use Exporter; |
| … | |
… | |
| 283 | C<1>, which get turned into false and true in CBOR. |
283 | C<1>, which get turned into false and true in CBOR. |
| 284 | |
284 | |
| 285 | =item CBOR::XS::Tagged objects |
285 | =item CBOR::XS::Tagged objects |
| 286 | |
286 | |
| 287 | Objects of this type must be arrays consisting of a single C<[tag, value]> |
287 | 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 |
288 | pair. The (numerical) tag will be encoded as a CBOR tag, the value will |
| 289 | encoded as appropriate for the value. |
289 | be encoded as appropriate for the value. You cna use C<CBOR::XS::tag> to |
|
|
290 | create such objects. |
| 290 | |
291 | |
| 291 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
292 | =item Types::Serialiser::true, Types::Serialiser::false, Types::Serialiser::error |
| 292 | |
293 | |
| 293 | These special values become CBOR true, CBOR false and CBOR undefined |
294 | 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 |
295 | values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly |
| … | |
… | |
| 453 | This string is available as C<$CBOR::XS::MAGIC>. This module does not |
454 | This string is available as C<$CBOR::XS::MAGIC>. This module does not |
| 454 | prepend this string tot he CBOR data it generates, but it will ignroe it |
455 | prepend this string tot he CBOR data it generates, but it will ignroe it |
| 455 | if present, so users can prepend this string as a "file type" indicator as |
456 | if present, so users can prepend this string as a "file type" indicator as |
| 456 | required. |
457 | required. |
| 457 | |
458 | |
|
|
459 | |
|
|
460 | =head1 THE CBOR::XS::Tagged CLASS |
|
|
461 | |
|
|
462 | CBOR has the concept of tagged values - any CBOR value can be tagged with |
|
|
463 | a numeric 64 bit number, which are centrally administered. |
|
|
464 | |
|
|
465 | C<CBOR::XS> handles a few tags internally when en- or decoding. You can |
|
|
466 | also create tags yourself by encoding C<CBOR::XS::Tagged> objects, and the |
|
|
467 | decoder will create C<CBOR::XS::Tagged> objects itself when it hits an |
|
|
468 | unknown tag. |
|
|
469 | |
|
|
470 | These objects are simply blessed array references - the first member of |
|
|
471 | the array being the numerical tag, the second being the value. |
|
|
472 | |
|
|
473 | You can interact with C<CBOR::XS::Tagged> objects in the following ways: |
|
|
474 | |
|
|
475 | =over 4 |
|
|
476 | |
|
|
477 | =item $tagged = CBOR::XS::tag $tag, $value |
|
|
478 | |
|
|
479 | This function(!) creates a new C<CBOR::XS::Tagged> object using the given |
|
|
480 | C<$tag> (0..2**64-1) to tag the given C<$value> (which can be any Perl |
|
|
481 | value that can be encoded in CBOR, including serialisable Perl objects and |
|
|
482 | C<CBOR::XS::Tagged> objects). |
|
|
483 | |
|
|
484 | =item $tagged->[0] |
|
|
485 | |
|
|
486 | =item $tagged->[0] = $new_tag |
|
|
487 | |
|
|
488 | =item $tag = $tagged->tag |
|
|
489 | |
|
|
490 | =item $new_tag = $tagged->tag ($new_tag) |
|
|
491 | |
|
|
492 | Access/mutate the tag. |
|
|
493 | |
|
|
494 | =item $tagged->[1] |
|
|
495 | |
|
|
496 | =item $tagged->[1] = $new_value |
|
|
497 | |
|
|
498 | =item $value = $tagged->value |
|
|
499 | |
|
|
500 | =item $new_value = $tagged->value ($new_value) |
|
|
501 | |
|
|
502 | Access/mutate the tagged value. |
|
|
503 | |
|
|
504 | =back |
|
|
505 | |
|
|
506 | =cut |
|
|
507 | |
|
|
508 | sub tag($$) { |
|
|
509 | bless [@_], CBOR::XS::Tagged::; |
|
|
510 | } |
|
|
511 | |
|
|
512 | sub CBOR::XS::Tagged::tag { |
|
|
513 | $_[0][0] = $_[1] if $#_; |
|
|
514 | $_[0][0] |
|
|
515 | } |
|
|
516 | |
|
|
517 | sub CBOR::XS::Tagged::value { |
|
|
518 | $_[0][1] = $_[1] if $#_; |
|
|
519 | $_[0][1] |
|
|
520 | } |
|
|
521 | |
|
|
522 | =head2 EXAMPLES |
|
|
523 | |
|
|
524 | Here are some examples of C<CBOR::XS::Tagged> uses to tag objects. |
|
|
525 | |
|
|
526 | You can look up CBOR tag value and emanings in the IANA registry at |
|
|
527 | L<http://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml>. |
|
|
528 | |
|
|
529 | Prepend a magic header (C<$CBOR::XS::MAGIC>): |
|
|
530 | |
|
|
531 | my $cbor = encode_cbor CBOR::XS::tag 55799, $value; |
|
|
532 | # same as: |
|
|
533 | my $cbor = $CBOR::XS::MAGIC . encode_cbor $value; |
|
|
534 | |
|
|
535 | Serialise some URIs and a regex in an array: |
|
|
536 | |
|
|
537 | my $cbor = encode_cbor [ |
|
|
538 | (CBOR::XS::tag 32, "http://www.nethype.de/"), |
|
|
539 | (CBOR::XS::tag 32, "http://software.schmorp.de/"), |
|
|
540 | (CBOR::XS::tag 35, "^[Pp][Ee][Rr][lL]\$"), |
|
|
541 | ]; |
|
|
542 | |
|
|
543 | Wrap CBOR data in CBOR: |
|
|
544 | |
|
|
545 | my $cbor_cbor = encode_cbor |
|
|
546 | CBOR::XS::tag 24, |
|
|
547 | encode_cbor [1, 2, 3]; |
| 458 | |
548 | |
| 459 | =head1 CBOR and JSON |
549 | =head1 CBOR and JSON |
| 460 | |
550 | |
| 461 | CBOR is supposed to implement a superset of the JSON data model, and is, |
551 | CBOR is supposed to implement a superset of the JSON data model, and is, |
| 462 | with some coercion, able to represent all JSON texts (something that other |
552 | with some coercion, able to represent all JSON texts (something that other |
