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

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.19 by root, Wed Nov 20 01:09:46 2013 UTC vs.
Revision 1.21 by root, Wed Nov 20 16:29:02 2013 UTC

…		…
26	substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string	26	substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string
27	}	27	}
28		28
29	=head1 DESCRIPTION	29	=head1 DESCRIPTION
30		30
31	WARNING! This module is very new, and not very well tested (that's up to	31	WARNING! This module is very new, and not very well tested (that's up
32	you to do). Furthermore, details of the implementation might change freely	32	to you to do). Furthermore, details of the implementation might change
33	before version 1.0. And lastly, the object serialisation protocol depends	33	freely before version 1.0. And lastly, most extensions depend on an IANA
34	on a pending IANA assignment, and until that assignment is official, this	34	assignment, and until that assignment is official, this implementation is
35	implementation is not interoperable with other implementations (even	35	not interoperable with other implementations (even future versions of this
36	future versions of this module) until the assignment is done.	36	module) until the assignment is done.
37		37
38	You are still invited to try out CBOR, and this module.	38	You are still invited to try out CBOR, and this module.
39		39
40	This module converts Perl data structures to the Concise Binary Object	40	This module converts Perl data structures to the Concise Binary Object
41	Representation (CBOR) and vice versa. CBOR is a fast binary serialisation	41	Representation (CBOR) and vice versa. CBOR is a fast binary serialisation
…		…
54	data, the worse L<Storable> performs in comparison.	54	data, the worse L<Storable> performs in comparison.
55		55
56	As for compactness, C<CBOR::XS> encoded data structures are usually about	56	As for compactness, C<CBOR::XS> encoded data structures are usually about
57	20% smaller than the same data encoded as (compact) JSON or L<Storable>.	57	20% smaller than the same data encoded as (compact) JSON or L<Storable>.
58		58
		59	In addition to the core CBOR data format, this module implements a number
		60	of extensions, to support cyclic and self-referencing data structures
		61	(see C<allow_sharing>), string deduplication (see C<allow_stringref>) and
		62	scalar references (always enabled).
		63
59	The primary goal of this module is to be I<correct> and the secondary goal	64	The primary goal of this module is to be I<correct> and the secondary goal
60	is to be I<fast>. To reach the latter goal it was written in C.	65	is to be I<fast>. To reach the latter goal it was written in C.
61		66
62	See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and	67	See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and
63	vice versa.	68	vice versa.
…		…
171	exception when it encounters anything it cannot encode as CBOR.	176	exception when it encounters anything it cannot encode as CBOR.
172		177
173	This option does not affect C<decode> in any way, and it is recommended to	178	This option does not affect C<decode> in any way, and it is recommended to
174	leave it off unless you know your communications partner.	179	leave it off unless you know your communications partner.
175		180
176	=item $cbor = $cbor->allow_sharable ([$enable])	181	=item $cbor = $cbor->allow_sharing ([$enable])
177		182
178	=item $enabled = $cbor->get_allow_sharable	183	=item $enabled = $cbor->get_allow_sharing
179		184
180	If C<$enable> is true (or missing), then C<encode> will not double-encode	185	If C<$enable> is true (or missing), then C<encode> will not double-encode
181	values that have been seen before (e.g. when the same object, such as an	186	values that have been referenced before (e.g. when the same object, such
182	array, is referenced multiple times), but instead will emit a reference to	187	as an array, is referenced multiple times), but instead will emit a
183	the earlier value.	188	reference to the earlier value.
184		189
185	This means that such values will only be encoded once, and will not result	190	This means that such values will only be encoded once, and will not result
186	in a deep cloning of the value on decode, in decoders supporting the value	191	in a deep cloning of the value on decode, in decoders supporting the value
187	sharing extension.	192	sharing extension.
		193
		194	It is recommended to leave it off unless you know your
		195	communication partner supports the value sharing extensions to CBOR
		196	(http://cbor.schmorp.de/value-sharing).
188		197
189	Detecting shared values incurs a runtime overhead when values are encoded	198	Detecting shared values incurs a runtime overhead when values are encoded
190	that have a reference counter large than one, and might unnecessarily	199	that have a reference counter large than one, and might unnecessarily
191	increase the encoded size, as potentially shared values are encode as	200	increase the encoded size, as potentially shared values are encode as
192	sharable whether or not they are actually shared.	201	sharable whether or not they are actually shared.
193		202
194	At the moment, all shared values will be detected, even weird and unusual	203	At the moment, only targets of references can be shared (e.g. scalars,
195	cases, such as an array with multiple "copies" of the I<same> scalar,	204	arrays or hashes pointed to by a reference). Weirder constructs, such as
196	which are hard but not impossible to create in Perl (L<Storable> for	205	an array with multiple "copies" of the I<same> string, which are hard but
197	example doesn't handle these cases). If this turns out ot be a performance	206	not impossible to create in Perl, are not supported (this is the same as
198	issue then future versions might limit the shared value detection to	207	for L<Storable>).
199	references only.
200		208
201	If C<$enable> is false (the default), then C<encode> will encode	209	If C<$enable> is false (the default), then C<encode> will encode
202	exception when it encounters anything it cannot encode as CBOR.	210	exception when it encounters anything it cannot encode as CBOR.
203		211
204	This option does not affect C<decode> in any way - shared values and	212	This option does not affect C<decode> in any way - shared values and
205	references will always be decoded properly if present. It is recommended	213	references will always be decoded properly if present.
206	to leave it off unless you know your communications partner supports the	214
207	value sharing extensions to CBOR (http://cbor.schmorp.de/value-sharing).	215	=item $cbor = $cbor->allow_stringref ([$enable])
		216
		217	=item $enabled = $cbor->get_allow_stringref
		218
		219	If C<$enable> is true (or missing), then C<encode> will try not to encode
		220	the same string twice, but will instead encode a reference to the string
		221	instead. Depending on your data format. this can save a lot of space, but
		222	also results in a very large runtime overhead (expect encoding times to be
		223	2-4 times as high as without).
		224
		225	It is recommended to leave it off unless you know your
		226	communications partner supports the stringref extension to CBOR
		227	(http://cbor.schmorp.de/stringref).
		228
		229	If C<$enable> is false (the default), then C<encode> will encode
		230	exception when it encounters anything it cannot encode as CBOR.
		231
		232	This option does not affect C<decode> in any way - string references will
		233	always be decoded properly if present.
208		234
209	=item $cbor_data = $cbor->encode ($perl_scalar)	235	=item $cbor_data = $cbor->encode ($perl_scalar)
210		236
211	Converts the given Perl data structure (a scalar value) to its CBOR	237	Converts the given Perl data structure (a scalar value) to its CBOR
212	representation.	238	representation.
…		…
622	=item <unassigned>, <unassigned> (sharable, sharedref, L <http://cbor.schmorp.de/value-sharing>)	648	=item <unassigned>, <unassigned> (sharable, sharedref, L <http://cbor.schmorp.de/value-sharing>)
623		649
624	These tags are automatically decoded when encountered, resulting in	650	These tags are automatically decoded when encountered, resulting in
625	shared values in the decoded object. They are only encoded, however, when	651	shared values in the decoded object. They are only encoded, however, when
626	C<allow_sharable> is enabled.	652	C<allow_sharable> is enabled.
		653
		654	=item <unassigned>, <unassigned> (stringref-namespace, stringref, L <http://cbor.schmorp.de/stringref>)
		655
		656	These tags are automatically decoded when encountered. They are only
		657	encoded, however, when C<allow_stringref> is enabled.
627		658
628	=item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)	659	=item 22098 (indirection, L<http://cbor.schmorp.de/indirection>)
629		660
630	This tag is automatically generated when a reference are encountered (with	661	This tag is automatically generated when a reference are encountered (with
631	the exception of hash and array refernces). It is converted to a reference	662	the exception of hash and array refernces). It is converted to a reference

Diff Legend

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

Comparing CBOR-XS/XS.pm (file contents): Revision 1.19 by root, Wed Nov 20 01:09:46 2013 UTC vs. Revision 1.21 by root, Wed Nov 20 16:29:02 2013 UTC

Diff Legend

Comparing CBOR-XS/XS.pm (file contents):
Revision 1.19 by root, Wed Nov 20 01:09:46 2013 UTC vs.
Revision 1.21 by root, Wed Nov 20 16:29:02 2013 UTC