… | |
… | |
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; |
… | |
… | |
121 | but configures the coder object to be safe to use with untrusted |
121 | but configures the coder object to be safe to use with untrusted |
122 | data. Currently, this is equivalent to: |
122 | data. Currently, this is equivalent to: |
123 | |
123 | |
124 | my $cbor = CBOR::XS |
124 | my $cbor = CBOR::XS |
125 | ->new |
125 | ->new |
|
|
126 | ->validate_utf8 |
126 | ->forbid_objects |
127 | ->forbid_objects |
127 | ->filter (\&CBOR::XS::safe_filter) |
128 | ->filter (\&CBOR::XS::safe_filter) |
128 | ->max_size (1e8); |
129 | ->max_size (1e8); |
129 | |
130 | |
130 | But is more future proof (it is better to crash because of a change than |
131 | But is more future proof (it is better to crash because of a change than |
… | |
… | |
133 | =cut |
134 | =cut |
134 | |
135 | |
135 | sub new_safe { |
136 | sub new_safe { |
136 | CBOR::XS |
137 | CBOR::XS |
137 | ->new |
138 | ->new |
|
|
139 | ->validate_utf8 |
138 | ->forbid_objects |
140 | ->forbid_objects |
139 | ->filter (\&CBOR::XS::safe_filter) |
141 | ->filter (\&CBOR::XS::safe_filter) |
140 | ->max_size (1e8) |
142 | ->max_size (1e8) |
141 | } |
143 | } |
142 | |
144 | |
… | |
… | |
704 | =back |
706 | =back |
705 | |
707 | |
706 | =head2 TYPE CASTS |
708 | =head2 TYPE CASTS |
707 | |
709 | |
708 | B<EXPERIMENTAL>: As an experimental extension, C<CBOR::XS> allows you to |
710 | 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 |
711 | 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 |
712 | encode types not normally accessible (e.g. half floats) as well as force |
711 | string types even when C<text_strings> is in effect. |
713 | string types even when C<text_strings> is in effect. |
712 | |
714 | |
713 | Type forcing is done by calling a special "cast" function which keeps a |
715 | 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 |
716 | copy of the value and returns a new value that can be handed over to any |
715 | CBOR encoder function. |
717 | CBOR encoder function. |
716 | |
718 | |
717 | The following casts are currently available (all of which are unary operators): |
719 | The following casts are currently available (all of which are unary |
|
|
720 | operators, that is, have a prototype of C<$>): |
718 | |
721 | |
719 | =over |
722 | =over |
720 | |
723 | |
721 | =item CBOR::XS::as_int $value |
724 | =item CBOR::XS::as_int $value |
722 | |
725 | |
… | |
… | |
729 | |
732 | |
730 | =item CBOR::XS::as_bytes $value |
733 | =item CBOR::XS::as_bytes $value |
731 | |
734 | |
732 | Forces the value to be encoded as a (binary) string value. |
735 | Forces the value to be encoded as a (binary) string value. |
733 | |
736 | |
|
|
737 | Example: encode a perl string as binary even though C<text_strings> is in |
|
|
738 | effect. |
|
|
739 | |
|
|
740 | CBOR::XS->new->text_strings->encode ([4, "text", CBOR::XS::bytes "bytevalue"]); |
|
|
741 | |
|
|
742 | =item CBOR::XS::as_bool $value |
|
|
743 | |
|
|
744 | Converts a Perl boolean (which can be any kind of scalar) into a CBOR |
|
|
745 | boolean. Strictly the same, but shorter to write, than: |
|
|
746 | |
|
|
747 | $value ? Types::Serialiser::true : Types::Serialiser::false |
|
|
748 | |
734 | =item CBOR::XS::as_float16 $value |
749 | =item CBOR::XS::as_float16 $value |
735 | |
750 | |
736 | Forces half-float (IEEE 754 binary16) encoding of the given value. |
751 | Forces half-float (IEEE 754 binary16) encoding of the given value. |
737 | |
752 | |
738 | =item CBOR::XS::as_float32 $value |
753 | =item CBOR::XS::as_float32 $value |
… | |
… | |
741 | |
756 | |
742 | =item CBOR::XS::as_float64 $value |
757 | =item CBOR::XS::as_float64 $value |
743 | |
758 | |
744 | Forces double-float (IEEE 754 binary64) encoding of the given value. |
759 | Forces double-float (IEEE 754 binary64) encoding of the given value. |
745 | |
760 | |
746 | =item, CBOR::XS::as_cbor $cbor_text |
761 | =item CBOR::XS::as_cbor $cbor_text |
747 | |
762 | |
748 | Bot a type cast per-se, this type cast forces the argument to eb encoded |
763 | Not a type cast per-se, this type cast forces the argument to be encoded |
749 | as-is. This can be used to embed pre-encoded CBOR data. |
764 | as-is. This can be used to embed pre-encoded CBOR data. |
750 | |
765 | |
751 | Note that no checking on the validity of the C<$cbor_text> is done - it's |
766 | Note that no checking on the validity of the C<$cbor_text> is done - it's |
752 | the callers responsibility to correctly encode values. |
767 | the callers responsibility to correctly encode values. |
753 | |
768 | |
|
|
769 | =item CBOR::XS::as_map [key => value...] |
|
|
770 | |
|
|
771 | Treat the array reference as key value pairs and output a CBOR map. This |
|
|
772 | allows you to generate CBOR maps with arbitrary key types (or, if you |
|
|
773 | don't care about semantics, duplicate keys or pairs in a custom order), |
|
|
774 | which is otherwise hard to do with Perl. |
|
|
775 | |
|
|
776 | The single argument must be an array reference with an even number of |
|
|
777 | elements. |
|
|
778 | |
|
|
779 | Note that only the reference to the array is copied, the array itself is |
|
|
780 | not. Modifications done to the array before calling an encoding function |
|
|
781 | will be reflected in the encoded output. |
|
|
782 | |
|
|
783 | Example: encode a CBOR map with a string and an integer as keys. |
|
|
784 | |
|
|
785 | encode_cbor CBOR::XS::as_map [string => "value", 5 => "value"] |
|
|
786 | |
754 | =back |
787 | =back |
755 | |
788 | |
756 | Example: encode a perl string as binary even though C<text_strings> is in |
|
|
757 | effect. |
|
|
758 | |
|
|
759 | CBOR::XS->new->text_strings->encode ([4, "text", CBOR::XS::bytes "bytevalue"]); |
|
|
760 | |
|
|
761 | =cut |
789 | =cut |
762 | |
790 | |
763 | sub CBOR::XS::as_int ($) { bless [$_[0], 0, undef], CBOR::XS::Tagged:: } |
|
|
764 | sub CBOR::XS::as_cbor ($) { bless [$_[0], 1, undef], CBOR::XS::Tagged:: } |
791 | sub CBOR::XS::as_cbor ($) { bless [$_[0], 0, undef], CBOR::XS::Tagged:: } |
|
|
792 | sub CBOR::XS::as_int ($) { bless [$_[0], 1, undef], CBOR::XS::Tagged:: } |
765 | sub CBOR::XS::as_bytes ($) { bless [$_[0], 2, undef], CBOR::XS::Tagged:: } |
793 | sub CBOR::XS::as_bytes ($) { bless [$_[0], 2, undef], CBOR::XS::Tagged:: } |
766 | sub CBOR::XS::as_text ($) { bless [$_[0], 3, undef], CBOR::XS::Tagged:: } |
794 | sub CBOR::XS::as_text ($) { bless [$_[0], 3, undef], CBOR::XS::Tagged:: } |
767 | sub CBOR::XS::as_float16 ($) { bless [$_[0], 4, undef], CBOR::XS::Tagged:: } |
795 | sub CBOR::XS::as_float16 ($) { bless [$_[0], 4, undef], CBOR::XS::Tagged:: } |
768 | sub CBOR::XS::as_float32 ($) { bless [$_[0], 5, undef], CBOR::XS::Tagged:: } |
796 | sub CBOR::XS::as_float32 ($) { bless [$_[0], 5, undef], CBOR::XS::Tagged:: } |
769 | sub CBOR::XS::as_float64 ($) { bless [$_[0], 6, undef], CBOR::XS::Tagged:: } |
797 | sub CBOR::XS::as_float64 ($) { bless [$_[0], 6, undef], CBOR::XS::Tagged:: } |
|
|
798 | |
|
|
799 | sub CBOR::XS::as_bool ($) { $_[0] ? $Types::Serialiser::true : $Types::Serialiser::false } |
|
|
800 | |
|
|
801 | sub CBOR::XS::as_map ($) { |
|
|
802 | ARRAY:: eq ref $_[0] |
|
|
803 | and $#{ $_[0] } & 1 |
|
|
804 | or do { require Carp; Carp::croak ("CBOR::XS::as_map only acepts array references with an even number of elements, caught") }; |
|
|
805 | |
|
|
806 | bless [$_[0], 7, undef], CBOR::XS::Tagged:: |
|
|
807 | } |
770 | |
808 | |
771 | =head2 OBJECT SERIALISATION |
809 | =head2 OBJECT SERIALISATION |
772 | |
810 | |
773 | This module implements both a CBOR-specific and the generic |
811 | This module implements both a CBOR-specific and the generic |
774 | L<Types::Serialier> object serialisation protocol. The following |
812 | L<Types::Serialier> object serialisation protocol. The following |