[ViewVC] Diff of: cvs/CBOR-XS/XS.pm

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.70 by root, Sat Nov 9 07:30:36 2019 UTC vs.
Revision 1.73 by root, Sun Nov 29 21:35:51 2020 UTC

…		…
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.8;
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
…		…
668	"$x"; # stringified	669	"$x"; # stringified
669	$x .= ""; # another, more awkward way to stringify	670	$x .= ""; # another, more awkward way to stringify
670	print $x; # perl does it for you, too, quite often	671	print $x; # perl does it for you, too, quite often
671		672
672	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
673	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).
674		675
675	utf8::upgrade $x; # encode $x as text string	676	utf8::upgrade $x; # encode $x as text string
676	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.
677		681
678	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
679	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
680	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
681	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>.
…		…
696	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
697	represent numerical values are supported, but might suffer loss of	701	represent numerical values are supported, but might suffer loss of
698	precision.	702	precision.
699		703
700	=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 operators):
		718
		719	=over
		720
		721	=item CBOR::XS::as_int $value
		722
		723	Forces the value to be encoded as some form of (basic, not bignum) integer
		724	type.
		725
		726	=item CBOR::XS::as_text $value
		727
		728	Forces the value to be encoded as (UTF-8) text values.
		729
		730	=item CBOR::XS::as_bytes $value
		731
		732	Forces the value to be encoded as a (binary) string value.
		733
		734	=item CBOR::XS::as_float16 $value
		735
		736	Forces half-float (IEEE 754 binary16) encoding of the given value.
		737
		738	=item CBOR::XS::as_float32 $value
		739
		740	Forces single-float (IEEE 754 binary32) encoding of the given value.
		741
		742	=item CBOR::XS::as_float64 $value
		743
		744	Forces double-float (IEEE 754 binary64) encoding of the given value.
		745
		746	=item, CBOR::XS::as_cbor $cbor_text
		747
		748	Bot a type cast per-se, this type cast forces the argument to eb encoded
		749	as-is. This can be used to embed pre-encoded CBOR data.
		750
		751	Note that no checking on the validity of the C<$cbor_text> is done - it's
		752	the callers responsibility to correctly encode values.
		753
		754	=back
		755
		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
		762
		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:: }
		765	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:: }
		767	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:: }
		769	sub CBOR::XS::as_float64 ($) { bless [$_[0], 6, undef], CBOR::XS::Tagged:: }
701		770
702	=head2 OBJECT SERIALISATION	771	=head2 OBJECT SERIALISATION
703		772
704	This module implements both a CBOR-specific and the generic	773	This module implements both a CBOR-specific and the generic
705	L<Types::Serialier> object serialisation protocol. The following	774	L<Types::Serialier> object serialisation protocol. The following
…		…
1228	=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT	1297	=head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT
1229		1298
1230	On perls that were built without 64 bit integer support (these are rare	1299	On perls that were built without 64 bit integer support (these are rare
1231	nowadays, even on 32 bit architectures, as all major Perl distributions	1300	nowadays, even on 32 bit architectures, as all major Perl distributions
1232	are built with 64 bit integer support), support for any kind of 64 bit	1301	are built with 64 bit integer support), support for any kind of 64 bit
1233	integer in CBOR is very limited - most likely, these 64 bit values will	1302	value in CBOR is very limited - most likely, these 64 bit values will
1234	be truncated, corrupted, or otherwise not decoded correctly. This also	1303	be truncated, corrupted, or otherwise not decoded correctly. This also
1235	includes string, array and map sizes that are stored as 64 bit integers.	1304	includes string, float, array and map sizes that are stored as 64 bit
		1305	integers.
1236		1306
1237		1307
1238	=head1 THREADS	1308	=head1 THREADS
1239		1309
1240	This module is I<not> guaranteed to be thread safe and there are no	1310	This module is I<not> guaranteed to be thread safe and there are no

Diff Legend

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

Comparing CBOR-XS/XS.pm (file contents): Revision 1.70 by root, Sat Nov 9 07:30:36 2019 UTC vs. Revision 1.73 by root, Sun Nov 29 21:35:51 2020 UTC

Diff Legend

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.70 by root, Sat Nov 9 07:30:36 2019 UTC vs.
Revision 1.73 by root, Sun Nov 29 21:35:51 2020 UTC