--- CBOR-XS/XS.pm 2014/01/05 14:24:54 1.40 +++ CBOR-XS/XS.pm 2016/02/08 04:11:11 1.46 @@ -66,7 +66,7 @@ use common::sense; -our $VERSION = 1.25; +our $VERSION = 1.4; our @ISA = qw(Exporter); our @EXPORT = qw(encode_cbor decode_cbor); @@ -220,8 +220,13 @@ If C<$enable> is false (the default), then C will throw an error when it encounters a self-referential/cyclic data structure. +FUTURE DIRECTION: the motivation behind this option is to avoid I +cycles - future versions of this module might chose to decode cyclic data +structures using weak references when this option is off, instead of +throwing an error. + This option does not affect C in any way - shared values and -references will always be decoded properly if present. +references will always be encoded properly if present. =item $cbor = $cbor->pack_strings ([$enable]) @@ -811,7 +816,7 @@ objects using the C methods (the L object serialisation protocol). See L for details. -=item 28, 29 (shareable, sharedref, L ) +=item 28, 29 (shareable, sharedref, L) These tags are automatically decoded when encountered (and they do not result in a cyclic data structure, see C), resulting in @@ -831,7 +836,7 @@ to be supported in the encoder. The decoder, however, will decode these values as shared values. -=item 256, 25 (stringref-namespace, stringref, L ) +=item 256, 25 (stringref-namespace, stringref, L) These tags are automatically decoded when encountered. They are only encoded, however, when C is enabled. @@ -1019,7 +1024,8 @@ =head1 LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT On perls that were built without 64 bit integer support (these are rare -nowadays, even on 32 bit architectures), support for any kind of 64 bit +nowadays, even on 32 bit architectures, as all major Perl distributions +are built with 64 bit integer support), support for any kind of 64 bit integer in CBOR is very limited - most likely, these 64 bit values will be truncated, corrupted, or otherwise not decoded correctly. This also includes string, array and map sizes that are stored as 64 bit integers.