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.77 by root, Fri Dec 4 02:57:14 2020 UTC vs.
Revision 1.84 by root, Sat Oct 23 03:00:31 2021 UTC

… …
64 64
65package CBOR::XS; 65package CBOR::XS;
66 66
67use common::sense; 67use common::sense;
68 68
69our $VERSION = 1.82; 69our $VERSION = 1.85;
70our @ISA = qw(Exporter); 70our @ISA = qw(Exporter);
71 71
72our @EXPORT = qw(encode_cbor decode_cbor); 72our @EXPORT = qw(encode_cbor decode_cbor);
73 73
74use Exporter; 74use Exporter;
… …
121but configures the coder object to be safe to use with untrusted 121but configures the coder object to be safe to use with untrusted
122data. Currently, this is equivalent to: 122data. 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
130But is more future proof (it is better to crash because of a change than 131But is more future proof (it is better to crash because of a change than
… …
133=cut 134=cut
134 135
135sub new_safe { 136sub 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
708B<EXPERIMENTAL>: As an experimental extension, C<CBOR::XS> allows you to 710B<EXPERIMENTAL>: As an experimental extension, C<CBOR::XS> allows you to
709force specific cbor types to be used when encoding. That allows you to 711force specific CBOR types to be used when encoding. That allows you to
710encode types not normally accessible (e.g. half floats) as well as force 712encode types not normally accessible (e.g. half floats) as well as force
711string types even when C<text_strings> is in effect. 713string types even when C<text_strings> is in effect.
712 714
713Type forcing is done by calling a special "cast" function which keeps a 715Type forcing is done by calling a special "cast" function which keeps a
714copy of the value and returns a new value that can be handed over to any 716copy of the value and returns a new value that can be handed over to any
715CBOR encoder function. 717CBOR encoder function.
716 718
717The following casts are currently available (all of which are unary operators): 719The following casts are currently available (all of which are unary
720operators, 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
756Forces double-float (IEEE 754 binary64) encoding of the given value. 759Forces 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
760Not a type cast per-se, this type cast forces the argument to eb encoded 763Not a type cast per-se, this type cast forces the argument to be encoded
761as-is. This can be used to embed pre-encoded CBOR data. 764as-is. This can be used to embed pre-encoded CBOR data.
762 765
763Note that no checking on the validity of the C<$cbor_text> is done - it's 766Note that no checking on the validity of the C<$cbor_text> is done - it's
764the callers responsibility to correctly encode values. 767the 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
768Treat the array reference as key value pairs and output a CBOR map. This 771Treat the array reference as key value pairs and output a CBOR map. This
769allows you to generate CBOR maps with arbitrary key types (or, if you 772allows you to generate CBOR maps with arbitrary key types (or, if you
770don't care about semantics, duplicate keys or prairs in a custom order), 773don't care about semantics, duplicate keys or pairs in a custom order),
771which is otherwise hard to do with Perl. 774which is otherwise hard to do with Perl.
772 775
773The single argument must be an array reference with an even number of 776The single argument must be an array reference with an even number of
774elements. 777elements.
778
779Note that only the reference to the array is copied, the array itself is
780not. Modifications done to the array before calling an encoding function
781will be reflected in the encoded output.
775 782
776Example: encode a CBOR map with a string and an integer as keys. 783Example: 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
… …
792sub CBOR::XS::as_bool ($) { $_[0] ? $Types::Serialiser::true : $Types::Serialiser::false } 799sub CBOR::XS::as_bool ($) { $_[0] ? $Types::Serialiser::true : $Types::Serialiser::false }
793 800
794sub CBOR::XS::as_map ($) { 801sub CBOR::XS::as_map ($) {
795 ARRAY:: eq ref $_[0] 802 ARRAY:: eq ref $_[0]
796 and $#{ $_[0] } & 1 803 and $#{ $_[0] } & 1
797 or do { require Carp; Carp::croak ("CBOR::XS::as_map only acepts array references with an even number of elements, found ") }; 804 or do { require Carp; Carp::croak ("CBOR::XS::as_map only acepts array references with an even number of elements, caught") };
798 805
799 bless [$_[0], 7, undef], CBOR::XS::Tagged:: 806 bless [$_[0], 7, undef], CBOR::XS::Tagged::
800} 807}
801 808
802=head2 OBJECT SERIALISATION 809=head2 OBJECT SERIALISATION

Diff Legend

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