… | |
… | |
64 | |
64 | |
65 | package CBOR::XS; |
65 | package CBOR::XS; |
66 | |
66 | |
67 | use common::sense; |
67 | use common::sense; |
68 | |
68 | |
69 | our $VERSION = 1.71; |
69 | our $VERSION = 1.83; |
70 | our @ISA = qw(Exporter); |
70 | our @ISA = qw(Exporter); |
71 | |
71 | |
72 | our @EXPORT = qw(encode_cbor decode_cbor); |
72 | our @EXPORT = qw(encode_cbor decode_cbor); |
73 | |
73 | |
74 | use Exporter; |
74 | use Exporter; |
… | |
… | |
330 | strings as CBOR byte strings. |
330 | strings as CBOR byte strings. |
331 | |
331 | |
332 | This option does not affect C<decode> in any way. |
332 | This option does not affect C<decode> in any way. |
333 | |
333 | |
334 | This option has similar advantages and disadvantages as C<text_keys>. In |
334 | This option has similar advantages and disadvantages as C<text_keys>. In |
335 | addition, this option effectively removes the ability to encode byte |
335 | addition, this option effectively removes the ability to automatically |
336 | strings, which might break some C<FREEZE> and C<TO_CBOR> methods that rely |
336 | encode byte strings, which might break some C<FREEZE> and C<TO_CBOR> |
337 | on this, such as bignum encoding, so this option is mainly useful for very |
337 | methods that rely on this. |
338 | simple data. |
338 | |
|
|
339 | A workaround is to use explicit type casts, which are unaffected by this option. |
339 | |
340 | |
340 | =item $cbor = $cbor->validate_utf8 ([$enable]) |
341 | =item $cbor = $cbor->validate_utf8 ([$enable]) |
341 | |
342 | |
342 | =item $enabled = $cbor->get_validate_utf8 |
343 | =item $enabled = $cbor->get_validate_utf8 |
343 | |
344 | |
… | |
… | |
453 | when there is trailing garbage after the CBOR string, it will silently |
454 | when there is trailing garbage after the CBOR string, it will silently |
454 | stop parsing there and return the number of characters consumed so far. |
455 | stop parsing there and return the number of characters consumed so far. |
455 | |
456 | |
456 | This is useful if your CBOR texts are not delimited by an outer protocol |
457 | This is useful if your CBOR texts are not delimited by an outer protocol |
457 | and you need to know where the first CBOR string ends amd the next one |
458 | and you need to know where the first CBOR string ends amd the next one |
458 | starts. |
459 | starts - CBOR strings are self-delimited, so it is possible to concatenate |
|
|
460 | CBOR strings without any delimiters or size fields and recover their data. |
459 | |
461 | |
460 | CBOR::XS->new->decode_prefix ("......") |
462 | CBOR::XS->new->decode_prefix ("......") |
461 | => ("...", 3) |
463 | => ("...", 3) |
462 | |
464 | |
463 | =back |
465 | =back |
… | |
… | |
667 | "$x"; # stringified |
669 | "$x"; # stringified |
668 | $x .= ""; # another, more awkward way to stringify |
670 | $x .= ""; # another, more awkward way to stringify |
669 | print $x; # perl does it for you, too, quite often |
671 | print $x; # perl does it for you, too, quite often |
670 | |
672 | |
671 | You can force whether a string is encoded as byte or text string by using |
673 | You can force whether a string is encoded as byte or text string by using |
672 | C<utf8::upgrade> and C<utf8::downgrade> (if C<text_strings> is disabled): |
674 | C<utf8::upgrade> and C<utf8::downgrade> (if C<text_strings> is disabled). |
673 | |
675 | |
674 | utf8::upgrade $x; # encode $x as text string |
676 | utf8::upgrade $x; # encode $x as text string |
675 | utf8::downgrade $x; # encode $x as byte string |
677 | utf8::downgrade $x; # encode $x as byte string |
|
|
678 | |
|
|
679 | More options are available, see L<TYPE CASTS>, below, and the C<text_keys> |
|
|
680 | and C<text_strings> options. |
676 | |
681 | |
677 | Perl doesn't define what operations up- and downgrade strings, so if the |
682 | Perl doesn't define what operations up- and downgrade strings, so if the |
678 | difference between byte and text is important, you should up- or downgrade |
683 | difference between byte and text is important, you should up- or downgrade |
679 | your string as late as possible before encoding. You can also force the |
684 | your string as late as possible before encoding. You can also force the |
680 | use of CBOR text strings by using C<text_keys> or C<text_strings>. |
685 | use of CBOR text strings by using C<text_keys> or C<text_strings>. |
… | |
… | |
695 | format will be used. Perls that use formats other than IEEE double to |
700 | format will be used. Perls that use formats other than IEEE double to |
696 | represent numerical values are supported, but might suffer loss of |
701 | represent numerical values are supported, but might suffer loss of |
697 | precision. |
702 | precision. |
698 | |
703 | |
699 | =back |
704 | =back |
|
|
705 | |
|
|
706 | =head2 TYPE CASTS |
|
|
707 | |
|
|
708 | B<EXPERIMENTAL>: As an experimental extension, C<CBOR::XS> allows you to |
|
|
709 | force specific cbor types to be used when encoding. That allows you to |
|
|
710 | encode types not normally accessible (e.g. half floats) as well as force |
|
|
711 | string types even when C<text_strings> is in effect. |
|
|
712 | |
|
|
713 | Type forcing is done by calling a special "cast" function which keeps a |
|
|
714 | copy of the value and returns a new value that can be handed over to any |
|
|
715 | CBOR encoder function. |
|
|
716 | |
|
|
717 | The following casts are currently available (all of which are unary |
|
|
718 | operators, that is, have a prototype of C<$>): |
|
|
719 | |
|
|
720 | =over |
|
|
721 | |
|
|
722 | =item CBOR::XS::as_int $value |
|
|
723 | |
|
|
724 | Forces the value to be encoded as some form of (basic, not bignum) integer |
|
|
725 | type. |
|
|
726 | |
|
|
727 | =item CBOR::XS::as_text $value |
|
|
728 | |
|
|
729 | Forces the value to be encoded as (UTF-8) text values. |
|
|
730 | |
|
|
731 | =item CBOR::XS::as_bytes $value |
|
|
732 | |
|
|
733 | Forces the value to be encoded as a (binary) string value. |
|
|
734 | |
|
|
735 | Example: encode a perl string as binary even though C<text_strings> is in |
|
|
736 | effect. |
|
|
737 | |
|
|
738 | CBOR::XS->new->text_strings->encode ([4, "text", CBOR::XS::bytes "bytevalue"]); |
|
|
739 | |
|
|
740 | =item CBOR::XS::as_bool $value |
|
|
741 | |
|
|
742 | Converts a Perl boolean (which can be any kind of scalar) into a CBOR |
|
|
743 | boolean. Strictly the same, but shorter to write, than: |
|
|
744 | |
|
|
745 | $value ? Types::Serialiser::true : Types::Serialiser::false |
|
|
746 | |
|
|
747 | =item CBOR::XS::as_float16 $value |
|
|
748 | |
|
|
749 | Forces half-float (IEEE 754 binary16) encoding of the given value. |
|
|
750 | |
|
|
751 | =item CBOR::XS::as_float32 $value |
|
|
752 | |
|
|
753 | Forces single-float (IEEE 754 binary32) encoding of the given value. |
|
|
754 | |
|
|
755 | =item CBOR::XS::as_float64 $value |
|
|
756 | |
|
|
757 | Forces double-float (IEEE 754 binary64) encoding of the given value. |
|
|
758 | |
|
|
759 | =item CBOR::XS::as_cbor $cbor_text |
|
|
760 | |
|
|
761 | Not a type cast per-se, this type cast forces the argument to eb encoded |
|
|
762 | as-is. This can be used to embed pre-encoded CBOR data. |
|
|
763 | |
|
|
764 | Note that no checking on the validity of the C<$cbor_text> is done - it's |
|
|
765 | the callers responsibility to correctly encode values. |
|
|
766 | |
|
|
767 | =item CBOR::XS::as_map [key => value...] |
|
|
768 | |
|
|
769 | Treat the array reference as key value pairs and output a CBOR map. This |
|
|
770 | allows you to generate CBOR maps with arbitrary key types (or, if you |
|
|
771 | don't care about semantics, duplicate keys or prairs in a custom order), |
|
|
772 | which is otherwise hard to do with Perl. |
|
|
773 | |
|
|
774 | The single argument must be an array reference with an even number of |
|
|
775 | elements. |
|
|
776 | |
|
|
777 | Example: encode a CBOR map with a string and an integer as keys. |
|
|
778 | |
|
|
779 | encode_cbor CBOR::XS::as_map [string => "value", 5 => "value"] |
|
|
780 | |
|
|
781 | =back |
|
|
782 | |
|
|
783 | =cut |
|
|
784 | |
|
|
785 | sub CBOR::XS::as_cbor ($) { bless [$_[0], 0, undef], CBOR::XS::Tagged:: } |
|
|
786 | sub CBOR::XS::as_int ($) { bless [$_[0], 1, undef], CBOR::XS::Tagged:: } |
|
|
787 | sub CBOR::XS::as_bytes ($) { bless [$_[0], 2, undef], CBOR::XS::Tagged:: } |
|
|
788 | sub CBOR::XS::as_text ($) { bless [$_[0], 3, undef], CBOR::XS::Tagged:: } |
|
|
789 | sub CBOR::XS::as_float16 ($) { bless [$_[0], 4, undef], CBOR::XS::Tagged:: } |
|
|
790 | sub CBOR::XS::as_float32 ($) { bless [$_[0], 5, undef], CBOR::XS::Tagged:: } |
|
|
791 | sub CBOR::XS::as_float64 ($) { bless [$_[0], 6, undef], CBOR::XS::Tagged:: } |
|
|
792 | |
|
|
793 | sub CBOR::XS::as_bool ($) { $_[0] ? $Types::Serialiser::true : $Types::Serialiser::false } |
|
|
794 | |
|
|
795 | sub CBOR::XS::as_map ($) { |
|
|
796 | ARRAY:: eq ref $_[0] |
|
|
797 | and $#{ $_[0] } & 1 |
|
|
798 | or do { require Carp; Carp::croak ("CBOR::XS::as_map only acepts array references with an even number of elements, caught") }; |
|
|
799 | |
|
|
800 | bless [$_[0], 7, undef], CBOR::XS::Tagged:: |
|
|
801 | } |
700 | |
802 | |
701 | =head2 OBJECT SERIALISATION |
803 | =head2 OBJECT SERIALISATION |
702 | |
804 | |
703 | This module implements both a CBOR-specific and the generic |
805 | This module implements both a CBOR-specific and the generic |
704 | L<Types::Serialier> object serialisation protocol. The following |
806 | L<Types::Serialier> object serialisation protocol. The following |
… | |
… | |
1227 | =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT |
1329 | =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT |
1228 | |
1330 | |
1229 | On perls that were built without 64 bit integer support (these are rare |
1331 | On perls that were built without 64 bit integer support (these are rare |
1230 | nowadays, even on 32 bit architectures, as all major Perl distributions |
1332 | nowadays, even on 32 bit architectures, as all major Perl distributions |
1231 | are built with 64 bit integer support), support for any kind of 64 bit |
1333 | are built with 64 bit integer support), support for any kind of 64 bit |
1232 | integer in CBOR is very limited - most likely, these 64 bit values will |
1334 | value in CBOR is very limited - most likely, these 64 bit values will |
1233 | be truncated, corrupted, or otherwise not decoded correctly. This also |
1335 | be truncated, corrupted, or otherwise not decoded correctly. This also |
1234 | includes string, array and map sizes that are stored as 64 bit integers. |
1336 | includes string, float, array and map sizes that are stored as 64 bit |
|
|
1337 | integers. |
1235 | |
1338 | |
1236 | |
1339 | |
1237 | =head1 THREADS |
1340 | =head1 THREADS |
1238 | |
1341 | |
1239 | This module is I<not> guaranteed to be thread safe and there are no |
1342 | This module is I<not> guaranteed to be thread safe and there are no |