… | |
… | |
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.83; |
69 | our $VERSION = 1.86; |
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 | |
… | |
… | |
471 | Perl data structure in memory at one time, it does allow you to parse a |
473 | Perl data structure in memory at one time, it does allow you to parse a |
472 | CBOR stream incrementally, using a similar to using "decode_prefix" to see |
474 | CBOR stream incrementally, using a similar to using "decode_prefix" to see |
473 | if a full CBOR object is available, but is much more efficient. |
475 | if a full CBOR object is available, but is much more efficient. |
474 | |
476 | |
475 | It basically works by parsing as much of a CBOR string as possible - if |
477 | It basically works by parsing as much of a CBOR string as possible - if |
476 | the CBOR data is not complete yet, the pasrer will remember where it was, |
478 | the CBOR data is not complete yet, the parser will remember where it was, |
477 | to be able to restart when more data has been accumulated. Once enough |
479 | to be able to restart when more data has been accumulated. Once enough |
478 | data is available to either decode a complete CBOR value or raise an |
480 | data is available to either decode a complete CBOR value or raise an |
479 | error, a real decode will be attempted. |
481 | error, a real decode will be attempted. |
480 | |
482 | |
481 | A typical use case would be a network protocol that consists of sending |
483 | A typical use case would be a network protocol that consists of sending |
… | |
… | |
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 | |
… | |
… | |
755 | |
758 | |
756 | Forces double-float (IEEE 754 binary64) encoding of the given value. |
759 | Forces double-float (IEEE 754 binary64) encoding of the given value. |
757 | |
760 | |
758 | =item CBOR::XS::as_cbor $cbor_text |
761 | =item CBOR::XS::as_cbor $cbor_text |
759 | |
762 | |
760 | Not 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 |
761 | 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. |
762 | |
765 | |
763 | 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 |
764 | the callers responsibility to correctly encode values. |
767 | the callers responsibility to correctly encode values. |
765 | |
768 | |
766 | =item CBOR::XS::as_map [key => value...] |
769 | =item CBOR::XS::as_map [key => value...] |
767 | |
770 | |
768 | Treat the array reference as key value pairs and output a CBOR map. This |
771 | Treat the array reference as key value pairs and output a CBOR map. This |
769 | allows you to generate CBOR maps with arbitrary key types (or, if you |
772 | allows you to generate CBOR maps with arbitrary key types (or, if you |
770 | don't care about semantics, duplicate keys or prairs in a custom order), |
773 | don't care about semantics, duplicate keys or pairs in a custom order), |
771 | which is otherwise hard to do with Perl. |
774 | which is otherwise hard to do with Perl. |
772 | |
775 | |
773 | The single argument must be an array reference with an even number of |
776 | The single argument must be an array reference with an even number of |
774 | elements. |
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. |
775 | |
782 | |
776 | Example: encode a CBOR map with a string and an integer as keys. |
783 | Example: encode a CBOR map with a string and an integer as keys. |
777 | |
784 | |
778 | encode_cbor CBOR::XS::as_map [string => "value", 5 => "value"] |
785 | encode_cbor CBOR::XS::as_map [string => "value", 5 => "value"] |
779 | |
786 | |