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.12 by root, Tue Oct 29 15:13:50 2013 UTC vs.
Revision 1.13 by root, Tue Oct 29 15:56:31 2013 UTC

… …
58 58
59package CBOR::XS; 59package CBOR::XS;
60 60
61use common::sense; 61use common::sense;
62 62
63our $VERSION = 0.05; 63our $VERSION = 0.06;
64our @ISA = qw(Exporter); 64our @ISA = qw(Exporter);
65 65
66our @EXPORT = qw(encode_cbor decode_cbor); 66our @EXPORT = qw(encode_cbor decode_cbor);
67 67
68use Exporter; 68use Exporter;
… …
283C<1>, which get turned into false and true in CBOR. 283C<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
287Objects of this type must be arrays consisting of a single C<[tag, value]> 287Objects of this type must be arrays consisting of a single C<[tag, value]>
288pair. The (numerical) tag will be encoded as a CBOR tag, the value will be 288pair. The (numerical) tag will be encoded as a CBOR tag, the value will
289encoded as appropriate for the value. 289be encoded as appropriate for the value. You cna use C<CBOR::XS::tag> to
290create 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
293These special values become CBOR true, CBOR false and CBOR undefined 294These special values become CBOR true, CBOR false and CBOR undefined
294values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly 295values, respectively. You can also use C<\1>, C<\0> and C<\undef> directly
… …
515 516
516sub CBOR::XS::Tagged::value { 517sub CBOR::XS::Tagged::value {
517 $_[0][1] = $_[1] if $#_; 518 $_[0][1] = $_[1] if $#_;
518 $_[0][1] 519 $_[0][1]
519} 520}
521
522=head2 EXAMPLES
523
524Here are some examples of C<CBOR::XS::Tagged> uses to tag objects.
525
526You can look up CBOR tag value and emanings in the IANA registry at
527L<http://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml>.
528
529Prepend 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
535Serialise 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
543Wrap CBOR data in CBOR:
544
545 my $cbor_cbor = encode_cbor
546 CBOR::XS::tag 24,
547 encode_cbor [1, 2, 3];
520 548
521=head1 CBOR and JSON 549=head1 CBOR and JSON
522 550
523CBOR is supposed to implement a superset of the JSON data model, and is, 551CBOR is supposed to implement a superset of the JSON data model, and is,
524with some coercion, able to represent all JSON texts (something that other 552with some coercion, able to represent all JSON texts (something that other

Diff Legend

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