… | |
… | |
21 | # data was decoded |
21 | # data was decoded |
22 | substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string |
22 | substr $many_cbor_strings, 0, $length, ""; # remove decoded cbor string |
23 | } |
23 | } |
24 | |
24 | |
25 | DESCRIPTION |
25 | DESCRIPTION |
26 | WARNING! This module is very new, and not very well tested (that's up to |
|
|
27 | you to do). Furthermore, details of the implementation might change |
|
|
28 | freely before version 1.0. And lastly, most extensions depend on an IANA |
|
|
29 | assignment, and until that assignment is official, this implementation |
|
|
30 | is not interoperable with other implementations (even future versions of |
|
|
31 | this module) until the assignment is done. |
|
|
32 | |
|
|
33 | You are still invited to try out CBOR, and this module. |
|
|
34 | |
|
|
35 | This module converts Perl data structures to the Concise Binary Object |
26 | This module converts Perl data structures to the Concise Binary Object |
36 | Representation (CBOR) and vice versa. CBOR is a fast binary |
27 | Representation (CBOR) and vice versa. CBOR is a fast binary |
37 | serialisation format that aims to use a superset of the JSON data model, |
28 | serialisation format that aims to use an (almost) superset of the JSON |
38 | i.e. when you can represent something in JSON, you should be able to |
29 | data model, i.e. when you can represent something useful in JSON, you |
39 | represent it in CBOR. |
30 | should be able to represent it in CBOR. |
40 | |
31 | |
41 | In short, CBOR is a faster and very compact binary alternative to JSON, |
32 | In short, CBOR is a faster and quite compact binary alternative to JSON, |
42 | with the added ability of supporting serialisation of Perl objects. |
33 | with the added ability of supporting serialisation of Perl objects. |
43 | (JSON often compresses better than CBOR though, so if you plan to |
34 | (JSON often compresses better than CBOR though, so if you plan to |
44 | compress the data later you might want to compare both formats first). |
35 | compress the data later and speed is less important you might want to |
|
|
36 | compare both formats first). |
45 | |
37 | |
46 | To give you a general idea about speed, with texts in the megabyte |
38 | To give you a general idea about speed, with texts in the megabyte |
47 | range, "CBOR::XS" usually encodes roughly twice as fast as Storable or |
39 | range, "CBOR::XS" usually encodes roughly twice as fast as Storable or |
48 | JSON::XS and decodes about 15%-30% faster than those. The shorter the |
40 | JSON::XS and decodes about 15%-30% faster than those. The shorter the |
49 | data, the worse Storable performs in comparison. |
41 | data, the worse Storable performs in comparison. |
50 | |
42 | |
51 | As for compactness, "CBOR::XS" encoded data structures are usually about |
43 | Regarding compactness, "CBOR::XS"-encoded data structures are usually |
52 | 20% smaller than the same data encoded as (compact) JSON or Storable. |
44 | about 20% smaller than the same data encoded as (compact) JSON or |
|
|
45 | Storable. |
53 | |
46 | |
54 | In addition to the core CBOR data format, this module implements a |
47 | In addition to the core CBOR data format, this module implements a |
55 | number of extensions, to support cyclic and self-referencing data |
48 | number of extensions, to support cyclic and shared data structures (see |
56 | structures (see "allow_sharing"), string deduplication (see |
49 | "allow_sharing" and "allow_cycles"), string deduplication (see |
57 | "allow_stringref") and scalar references (always enabled). |
50 | "pack_strings") and scalar references (always enabled). |
58 | |
51 | |
59 | The primary goal of this module is to be *correct* and the secondary |
52 | The primary goal of this module is to be *correct* and the secondary |
60 | goal is to be *fast*. To reach the latter goal it was written in C. |
53 | goal is to be *fast*. To reach the latter goal it was written in C. |
61 | |
54 | |
62 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
55 | See MAPPING, below, on how CBOR::XS maps perl values to CBOR values and |
… | |
… | |
147 | same object, such as an array, is referenced multiple times), but |
140 | same object, such as an array, is referenced multiple times), but |
148 | instead will emit a reference to the earlier value. |
141 | instead will emit a reference to the earlier value. |
149 | |
142 | |
150 | This means that such values will only be encoded once, and will not |
143 | This means that such values will only be encoded once, and will not |
151 | result in a deep cloning of the value on decode, in decoders |
144 | result in a deep cloning of the value on decode, in decoders |
152 | supporting the value sharing extension. |
145 | supporting the value sharing extension. This also makes it possible |
|
|
146 | to encode cyclic data structures (which need "allow_cycles" to ne |
|
|
147 | enabled to be decoded by this module). |
153 | |
148 | |
154 | It is recommended to leave it off unless you know your communication |
149 | It is recommended to leave it off unless you know your communication |
155 | partner supports the value sharing extensions to CBOR |
150 | partner supports the value sharing extensions to CBOR |
156 | (http://cbor.schmorp.de/value-sharing). |
151 | (<http://cbor.schmorp.de/value-sharing>), as without decoder |
|
|
152 | support, the resulting data structure might be unusable. |
157 | |
153 | |
158 | Detecting shared values incurs a runtime overhead when values are |
154 | Detecting shared values incurs a runtime overhead when values are |
159 | encoded that have a reference counter large than one, and might |
155 | encoded that have a reference counter large than one, and might |
160 | unnecessarily increase the encoded size, as potentially shared |
156 | unnecessarily increase the encoded size, as potentially shared |
161 | values are encode as sharable whether or not they are actually |
157 | values are encode as shareable whether or not they are actually |
162 | shared. |
158 | shared. |
163 | |
159 | |
164 | At the moment, only targets of references can be shared (e.g. |
160 | At the moment, only targets of references can be shared (e.g. |
165 | scalars, arrays or hashes pointed to by a reference). Weirder |
161 | scalars, arrays or hashes pointed to by a reference). Weirder |
166 | constructs, such as an array with multiple "copies" of the *same* |
162 | constructs, such as an array with multiple "copies" of the *same* |
167 | string, which are hard but not impossible to create in Perl, are not |
163 | string, which are hard but not impossible to create in Perl, are not |
168 | supported (this is the same as for Storable). |
164 | supported (this is the same as with Storable). |
169 | |
165 | |
170 | If $enable is false (the default), then "encode" will encode |
166 | If $enable is false (the default), then "encode" will encode shared |
171 | exception when it encounters anything it cannot encode as CBOR. |
167 | data structures repeatedly, unsharing them in the process. Cyclic |
|
|
168 | data structures cannot be encoded in this mode. |
172 | |
169 | |
173 | This option does not affect "decode" in any way - shared values and |
170 | This option does not affect "decode" in any way - shared values and |
174 | references will always be decoded properly if present. |
171 | references will always be decoded properly if present. |
175 | |
172 | |
|
|
173 | $cbor = $cbor->allow_cycles ([$enable]) |
|
|
174 | $enabled = $cbor->get_allow_cycles |
|
|
175 | If $enable is true (or missing), then "decode" will happily decode |
|
|
176 | self-referential (cyclic) data structures. By default these will not |
|
|
177 | be decoded, as they need manual cleanup to avoid memory leaks, so |
|
|
178 | code that isn't prepared for this will not leak memory. |
|
|
179 | |
|
|
180 | If $enable is false (the default), then "decode" will throw an error |
|
|
181 | when it encounters a self-referential/cyclic data structure. |
|
|
182 | |
|
|
183 | This option does not affect "encode" in any way - shared values and |
|
|
184 | references will always be decoded properly if present. |
|
|
185 | |
176 | $cbor = $cbor->allow_stringref ([$enable]) |
186 | $cbor = $cbor->pack_strings ([$enable]) |
177 | $enabled = $cbor->get_allow_stringref |
187 | $enabled = $cbor->get_pack_strings |
178 | If $enable is true (or missing), then "encode" will try not to |
188 | If $enable is true (or missing), then "encode" will try not to |
179 | encode the same string twice, but will instead encode a reference to |
189 | encode the same string twice, but will instead encode a reference to |
180 | the string instead. Depending on your data format. this can save a |
190 | the string instead. Depending on your data format, this can save a |
181 | lot of space, but also results in a very large runtime overhead |
191 | lot of space, but also results in a very large runtime overhead |
182 | (expect encoding times to be 2-4 times as high as without). |
192 | (expect encoding times to be 2-4 times as high as without). |
183 | |
193 | |
184 | It is recommended to leave it off unless you know your |
194 | It is recommended to leave it off unless you know your |
185 | communications partner supports the stringref extension to CBOR |
195 | communications partner supports the stringref extension to CBOR |
186 | (http://cbor.schmorp.de/stringref). |
196 | (<http://cbor.schmorp.de/stringref>), as without decoder support, |
|
|
197 | the resulting data structure might not be usable. |
187 | |
198 | |
188 | If $enable is false (the default), then "encode" will encode |
199 | If $enable is false (the default), then "encode" will encode strings |
189 | exception when it encounters anything it cannot encode as CBOR. |
200 | the standard CBOR way. |
190 | |
201 | |
191 | This option does not affect "decode" in any way - string references |
202 | This option does not affect "decode" in any way - string references |
192 | will always be decoded properly if present. |
203 | will always be decoded properly if present. |
|
|
204 | |
|
|
205 | $cbor = $cbor->validate_utf8 ([$enable]) |
|
|
206 | $enabled = $cbor->get_validate_utf8 |
|
|
207 | If $enable is true (or missing), then "decode" will validate that |
|
|
208 | elements (text strings) containing UTF-8 data in fact contain valid |
|
|
209 | UTF-8 data (instead of blindly accepting it). This validation |
|
|
210 | obviously takes extra time during decoding. |
|
|
211 | |
|
|
212 | The concept of "valid UTF-8" used is perl's concept, which is a |
|
|
213 | superset of the official UTF-8. |
|
|
214 | |
|
|
215 | If $enable is false (the default), then "decode" will blindly accept |
|
|
216 | UTF-8 data, marking them as valid UTF-8 in the resulting data |
|
|
217 | structure regardless of whether thats true or not. |
|
|
218 | |
|
|
219 | Perl isn't too happy about corrupted UTF-8 in strings, but should |
|
|
220 | generally not crash or do similarly evil things. Extensions might be |
|
|
221 | not so forgiving, so it's recommended to turn on this setting if you |
|
|
222 | receive untrusted CBOR. |
|
|
223 | |
|
|
224 | This option does not affect "encode" in any way - strings that are |
|
|
225 | supposedly valid UTF-8 will simply be dumped into the resulting CBOR |
|
|
226 | string without checking whether that is, in fact, true or not. |
193 | |
227 | |
194 | $cbor = $cbor->filter ([$cb->($tag, $value)]) |
228 | $cbor = $cbor->filter ([$cb->($tag, $value)]) |
195 | $cb_or_undef = $cbor->get_filter |
229 | $cb_or_undef = $cbor->get_filter |
196 | Sets or replaces the tagged value decoding filter (when $cb is |
230 | Sets or replaces the tagged value decoding filter (when $cb is |
197 | specified) or clears the filter (if no argument or "undef" is |
231 | specified) or clears the filter (if no argument or "undef" is |
… | |
… | |
218 | it must be a code reference that is called with tag and value, and |
252 | it must be a code reference that is called with tag and value, and |
219 | is responsible for decoding the value. If no entry exists, it |
253 | is responsible for decoding the value. If no entry exists, it |
220 | returns no values. |
254 | returns no values. |
221 | |
255 | |
222 | Example: decode all tags not handled internally into |
256 | Example: decode all tags not handled internally into |
223 | CBOR::XS::Tagged objects, with no other special handling (useful |
257 | "CBOR::XS::Tagged" objects, with no other special handling (useful |
224 | when working with potentially "unsafe" CBOR data). |
258 | when working with potentially "unsafe" CBOR data). |
225 | |
259 | |
226 | CBOR::XS->new->filter (sub { })->decode ($cbor_data); |
260 | CBOR::XS->new->filter (sub { })->decode ($cbor_data); |
227 | |
261 | |
228 | Example: provide a global filter for tag 1347375694, converting the |
262 | Example: provide a global filter for tag 1347375694, converting the |
… | |
… | |
253 | the next one starts. |
287 | the next one starts. |
254 | |
288 | |
255 | CBOR::XS->new->decode_prefix ("......") |
289 | CBOR::XS->new->decode_prefix ("......") |
256 | => ("...", 3) |
290 | => ("...", 3) |
257 | |
291 | |
|
|
292 | INCREMENTAL PARSING |
|
|
293 | In some cases, there is the need for incremental parsing of JSON texts. |
|
|
294 | While this module always has to keep both CBOR text and resulting Perl |
|
|
295 | data structure in memory at one time, it does allow you to parse a CBOR |
|
|
296 | stream incrementally, using a similar to using "decode_prefix" to see if |
|
|
297 | a full CBOR object is available, but is much more efficient. |
|
|
298 | |
|
|
299 | It basically works by parsing as much of a CBOR string as possible - if |
|
|
300 | the CBOR data is not complete yet, the pasrer will remember where it |
|
|
301 | was, to be able to restart when more data has been accumulated. Once |
|
|
302 | enough data is available to either decode a complete CBOR value or raise |
|
|
303 | an error, a real decode will be attempted. |
|
|
304 | |
|
|
305 | A typical use case would be a network protocol that consists of sending |
|
|
306 | and receiving CBOR-encoded messages. The solution that works with CBOR |
|
|
307 | and about anything else is by prepending a length to every CBOR value, |
|
|
308 | so the receiver knows how many octets to read. More compact (and |
|
|
309 | slightly slower) would be to just send CBOR values back-to-back, as |
|
|
310 | "CBOR::XS" knows where a CBOR value ends, and doesn't need an explicit |
|
|
311 | length. |
|
|
312 | |
|
|
313 | The following methods help with this: |
|
|
314 | |
|
|
315 | @decoded = $cbor->incr_parse ($buffer) |
|
|
316 | This method attempts to decode exactly one CBOR value from the |
|
|
317 | beginning of the given $buffer. The value is removed from the |
|
|
318 | $buffer on success. When $buffer doesn't contain a complete value |
|
|
319 | yet, it returns nothing. Finally, when the $buffer doesn't start |
|
|
320 | with something that could ever be a valid CBOR value, it raises an |
|
|
321 | exception, just as "decode" would. In the latter case the decoder |
|
|
322 | state is undefined and must be reset before being able to parse |
|
|
323 | further. |
|
|
324 | |
|
|
325 | This method modifies the $buffer in place. When no CBOR value can be |
|
|
326 | decoded, the decoder stores the current string offset. On the next |
|
|
327 | call, continues decoding at the place where it stopped before. For |
|
|
328 | this to make sense, the $buffer must begin with the same octets as |
|
|
329 | on previous unsuccessful calls. |
|
|
330 | |
|
|
331 | You can call this method in scalar context, in which case it either |
|
|
332 | returns a decoded value or "undef". This makes it impossible to |
|
|
333 | distinguish between CBOR null values (which decode to "undef") and |
|
|
334 | an unsuccessful decode, which is often acceptable. |
|
|
335 | |
|
|
336 | @decoded = $cbor->incr_parse_multiple ($buffer) |
|
|
337 | Same as "incr_parse", but attempts to decode as many CBOR values as |
|
|
338 | possible in one go, instead of at most one. Calls to "incr_parse" |
|
|
339 | and "incr_parse_multiple" can be interleaved. |
|
|
340 | |
|
|
341 | $cbor->incr_reset |
|
|
342 | Resets the incremental decoder. This throws away any saved state, so |
|
|
343 | that subsequent calls to "incr_parse" or "incr_parse_multiple" start |
|
|
344 | to parse a new CBOR value from the beginning of the $buffer again. |
|
|
345 | |
|
|
346 | This method can be caled at any time, but it *must* be called if you |
|
|
347 | want to change your $buffer or there was a decoding error and you |
|
|
348 | want to reuse the $cbor object for future incremental parsings. |
|
|
349 | |
258 | MAPPING |
350 | MAPPING |
259 | This section describes how CBOR::XS maps Perl values to CBOR values and |
351 | This section describes how CBOR::XS maps Perl values to CBOR values and |
260 | vice versa. These mappings are designed to "do the right thing" in most |
352 | vice versa. These mappings are designed to "do the right thing" in most |
261 | circumstances automatically, preserving round-tripping characteristics |
353 | circumstances automatically, preserving round-tripping characteristics |
262 | (what you put in comes out as something equivalent). |
354 | (what you put in comes out as something equivalent). |
… | |
… | |
269 | integers |
361 | integers |
270 | CBOR integers become (numeric) perl scalars. On perls without 64 bit |
362 | CBOR integers become (numeric) perl scalars. On perls without 64 bit |
271 | support, 64 bit integers will be truncated or otherwise corrupted. |
363 | support, 64 bit integers will be truncated or otherwise corrupted. |
272 | |
364 | |
273 | byte strings |
365 | byte strings |
274 | Byte strings will become octet strings in Perl (the byte values |
366 | Byte strings will become octet strings in Perl (the Byte values |
275 | 0..255 will simply become characters of the same value in Perl). |
367 | 0..255 will simply become characters of the same value in Perl). |
276 | |
368 | |
277 | UTF-8 strings |
369 | UTF-8 strings |
278 | UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be |
370 | UTF-8 strings in CBOR will be decoded, i.e. the UTF-8 octets will be |
279 | decoded into proper Unicode code points. At the moment, the validity |
371 | decoded into proper Unicode code points. At the moment, the validity |
… | |
… | |
297 | |
389 | |
298 | tagged values |
390 | tagged values |
299 | Tagged items consists of a numeric tag and another CBOR value. |
391 | Tagged items consists of a numeric tag and another CBOR value. |
300 | |
392 | |
301 | See "TAG HANDLING AND EXTENSIONS" and the description of "->filter" |
393 | See "TAG HANDLING AND EXTENSIONS" and the description of "->filter" |
302 | for details. |
394 | for details on which tags are handled how. |
303 | |
395 | |
304 | anything else |
396 | anything else |
305 | Anything else (e.g. unsupported simple values) will raise a decoding |
397 | Anything else (e.g. unsupported simple values) will raise a decoding |
306 | error. |
398 | error. |
307 | |
399 | |
308 | PERL -> CBOR |
400 | PERL -> CBOR |
309 | The mapping from Perl to CBOR is slightly more difficult, as Perl is a |
401 | The mapping from Perl to CBOR is slightly more difficult, as Perl is a |
310 | truly typeless language, so we can only guess which CBOR type is meant |
402 | typeless language. That means this module can only guess which CBOR type |
311 | by a Perl value. |
403 | is meant by a perl value. |
312 | |
404 | |
313 | hash references |
405 | hash references |
314 | Perl hash references become CBOR maps. As there is no inherent |
406 | Perl hash references become CBOR maps. As there is no inherent |
315 | ordering in hash keys (or CBOR maps), they will usually be encoded |
407 | ordering in hash keys (or CBOR maps), they will usually be encoded |
316 | in a pseudo-random order. |
408 | in a pseudo-random order. This order can be different each time a |
|
|
409 | hahs is encoded. |
317 | |
410 | |
318 | Currently, tied hashes will use the indefinite-length format, while |
411 | Currently, tied hashes will use the indefinite-length format, while |
319 | normal hashes will use the fixed-length format. |
412 | normal hashes will use the fixed-length format. |
320 | |
413 | |
321 | array references |
414 | array references |
322 | Perl array references become fixed-length CBOR arrays. |
415 | Perl array references become fixed-length CBOR arrays. |
323 | |
416 | |
324 | other references |
417 | other references |
325 | Other unblessed references are generally not allowed and will cause |
418 | Other unblessed references will be represented using the indirection |
326 | an exception to be thrown, except for references to the integers 0 |
419 | tag extension (tag value 22098, |
327 | and 1, which get turned into false and true in CBOR. |
420 | <http://cbor.schmorp.de/indirection>). CBOR decoders are guaranteed |
|
|
421 | to be able to decode these values somehow, by either "doing the |
|
|
422 | right thing", decoding into a generic tagged object, simply ignoring |
|
|
423 | the tag, or something else. |
328 | |
424 | |
329 | CBOR::XS::Tagged objects |
425 | CBOR::XS::Tagged objects |
330 | Objects of this type must be arrays consisting of a single "[tag, |
426 | Objects of this type must be arrays consisting of a single "[tag, |
331 | value]" pair. The (numerical) tag will be encoded as a CBOR tag, the |
427 | value]" pair. The (numerical) tag will be encoded as a CBOR tag, the |
332 | value will be encoded as appropriate for the value. You cna use |
428 | value will be encoded as appropriate for the value. You must use |
333 | "CBOR::XS::tag" to create such objects. |
429 | "CBOR::XS::tag" to create such objects. |
334 | |
430 | |
335 | Types::Serialiser::true, Types::Serialiser::false, |
431 | Types::Serialiser::true, Types::Serialiser::false, |
336 | Types::Serialiser::error |
432 | Types::Serialiser::error |
337 | These special values become CBOR true, CBOR false and CBOR undefined |
433 | These special values become CBOR true, CBOR false and CBOR undefined |
… | |
… | |
353 | # dump as number |
449 | # dump as number |
354 | encode_cbor [2] # yields [2] |
450 | encode_cbor [2] # yields [2] |
355 | encode_cbor [-3.0e17] # yields [-3e+17] |
451 | encode_cbor [-3.0e17] # yields [-3e+17] |
356 | my $value = 5; encode_cbor [$value] # yields [5] |
452 | my $value = 5; encode_cbor [$value] # yields [5] |
357 | |
453 | |
358 | # used as string, so dump as string |
454 | # used as string, so dump as string (either byte or text) |
359 | print $value; |
455 | print $value; |
360 | encode_cbor [$value] # yields ["5"] |
456 | encode_cbor [$value] # yields ["5"] |
361 | |
457 | |
362 | # undef becomes null |
458 | # undef becomes null |
363 | encode_cbor [undef] # yields [null] |
459 | encode_cbor [undef] # yields [null] |
… | |
… | |
366 | |
462 | |
367 | my $x = 3.1; # some variable containing a number |
463 | my $x = 3.1; # some variable containing a number |
368 | "$x"; # stringified |
464 | "$x"; # stringified |
369 | $x .= ""; # another, more awkward way to stringify |
465 | $x .= ""; # another, more awkward way to stringify |
370 | print $x; # perl does it for you, too, quite often |
466 | print $x; # perl does it for you, too, quite often |
|
|
467 | |
|
|
468 | You can force whether a string ie encoded as byte or text string by |
|
|
469 | using "utf8::upgrade" and "utf8::downgrade"): |
|
|
470 | |
|
|
471 | utf8::upgrade $x; # encode $x as text string |
|
|
472 | utf8::downgrade $x; # encode $x as byte string |
|
|
473 | |
|
|
474 | Perl doesn't define what operations up- and downgrade strings, so if |
|
|
475 | the difference between byte and text is important, you should up- or |
|
|
476 | downgrade your string as late as possible before encoding. |
371 | |
477 | |
372 | You can force the type to be a CBOR number by numifying it: |
478 | You can force the type to be a CBOR number by numifying it: |
373 | |
479 | |
374 | my $x = "3"; # some variable containing a string |
480 | my $x = "3"; # some variable containing a string |
375 | $x += 0; # numify it, ensuring it will be dumped as a number |
481 | $x += 0; # numify it, ensuring it will be dumped as a number |
… | |
… | |
385 | the IEEE double format will be used. Perls that use formats other |
491 | the IEEE double format will be used. Perls that use formats other |
386 | than IEEE double to represent numerical values are supported, but |
492 | than IEEE double to represent numerical values are supported, but |
387 | might suffer loss of precision. |
493 | might suffer loss of precision. |
388 | |
494 | |
389 | OBJECT SERIALISATION |
495 | OBJECT SERIALISATION |
|
|
496 | This module implements both a CBOR-specific and the generic |
|
|
497 | Types::Serialier object serialisation protocol. The following |
|
|
498 | subsections explain both methods. |
|
|
499 | |
|
|
500 | ENCODING |
390 | This module knows two way to serialise a Perl object: The CBOR-specific |
501 | This module knows two way to serialise a Perl object: The CBOR-specific |
391 | way, and the generic way. |
502 | way, and the generic way. |
392 | |
503 | |
393 | Whenever the encoder encounters a Perl object that it cnanot serialise |
504 | Whenever the encoder encounters a Perl object that it cannot serialise |
394 | directly (most of them), it will first look up the "TO_CBOR" method on |
505 | directly (most of them), it will first look up the "TO_CBOR" method on |
395 | it. |
506 | it. |
396 | |
507 | |
397 | If it has a "TO_CBOR" method, it will call it with the object as only |
508 | If it has a "TO_CBOR" method, it will call it with the object as only |
398 | argument, and expects exactly one return value, which it will then |
509 | argument, and expects exactly one return value, which it will then |
… | |
… | |
403 | "CBOR" as the second argument, to distinguish it from other serialisers. |
514 | "CBOR" as the second argument, to distinguish it from other serialisers. |
404 | |
515 | |
405 | The "FREEZE" method can return any number of values (i.e. zero or more). |
516 | The "FREEZE" method can return any number of values (i.e. zero or more). |
406 | These will be encoded as CBOR perl object, together with the classname. |
517 | These will be encoded as CBOR perl object, together with the classname. |
407 | |
518 | |
|
|
519 | These methods *MUST NOT* change the data structure that is being |
|
|
520 | serialised. Failure to comply to this can result in memory corruption - |
|
|
521 | and worse. |
|
|
522 | |
408 | If an object supports neither "TO_CBOR" nor "FREEZE", encoding will fail |
523 | If an object supports neither "TO_CBOR" nor "FREEZE", encoding will fail |
409 | with an error. |
524 | with an error. |
410 | |
525 | |
|
|
526 | DECODING |
411 | Objects encoded via "TO_CBOR" cannot be automatically decoded, but |
527 | Objects encoded via "TO_CBOR" cannot (normally) be automatically |
412 | objects encoded via "FREEZE" can be decoded using the following |
528 | decoded, but objects encoded via "FREEZE" can be decoded using the |
413 | protocol: |
529 | following protocol: |
414 | |
530 | |
415 | When an encoded CBOR perl object is encountered by the decoder, it will |
531 | When an encoded CBOR perl object is encountered by the decoder, it will |
416 | look up the "THAW" method, by using the stored classname, and will fail |
532 | look up the "THAW" method, by using the stored classname, and will fail |
417 | if the method cannot be found. |
533 | if the method cannot be found. |
418 | |
534 | |
… | |
… | |
439 | |
555 | |
440 | sub URI::TO_CBOR { |
556 | sub URI::TO_CBOR { |
441 | my ($self) = @_; |
557 | my ($self) = @_; |
442 | my $uri = "$self"; # stringify uri |
558 | my $uri = "$self"; # stringify uri |
443 | utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string |
559 | utf8::upgrade $uri; # make sure it will be encoded as UTF-8 string |
444 | CBOR::XS::tagged 32, "$_[0]" |
560 | CBOR::XS::tag 32, "$_[0]" |
445 | } |
561 | } |
446 | |
562 | |
447 | This will encode URIs as a UTF-8 string with tag 32, which indicates an |
563 | This will encode URIs as a UTF-8 string with tag 32, which indicates an |
448 | URI. |
564 | URI. |
449 | |
565 | |
… | |
… | |
568 | |
684 | |
569 | ENFORCED TAGS |
685 | ENFORCED TAGS |
570 | These tags are always handled when decoding, and their handling cannot |
686 | These tags are always handled when decoding, and their handling cannot |
571 | be overriden by the user. |
687 | be overriden by the user. |
572 | |
688 | |
573 | <unassigned> (perl-object, <http://cbor.schmorp.de/perl-object>) |
689 | 26 (perl-object, <http://cbor.schmorp.de/perl-object>) |
574 | These tags are automatically created (and decoded) for serialisable |
690 | These tags are automatically created (and decoded) for serialisable |
575 | objects using the "FREEZE/THAW" methods (the Types::Serialier object |
691 | objects using the "FREEZE/THAW" methods (the Types::Serialier object |
576 | serialisation protocol). See "OBJECT SERIALISATION" for details. |
692 | serialisation protocol). See "OBJECT SERIALISATION" for details. |
577 | |
693 | |
578 | <unassigned>, <unassigned> (sharable, sharedref, L |
694 | 28, 29 (shareable, sharedref, L <http://cbor.schmorp.de/value-sharing>) |
579 | <http://cbor.schmorp.de/value-sharing>) |
|
|
580 | These tags are automatically decoded when encountered, resulting in |
695 | These tags are automatically decoded when encountered (and they do |
|
|
696 | not result in a cyclic data structure, see "allow_cycles"), |
581 | shared values in the decoded object. They are only encoded, however, |
697 | resulting in shared values in the decoded object. They are only |
582 | when "allow_sharable" is enabled. |
698 | encoded, however, when "allow_sharing" is enabled. |
583 | |
699 | |
584 | <unassigned>, <unassigned> (stringref-namespace, stringref, L |
700 | Not all shared values can be successfully decoded: values that |
|
|
701 | reference themselves will *currently* decode as "undef" (this is not |
|
|
702 | the same as a reference pointing to itself, which will be |
|
|
703 | represented as a value that contains an indirect reference to itself |
|
|
704 | - these will be decoded properly). |
|
|
705 | |
|
|
706 | Note that considerably more shared value data structures can be |
|
|
707 | decoded than will be encoded - currently, only values pointed to by |
|
|
708 | references will be shared, others will not. While non-reference |
|
|
709 | shared values can be generated in Perl with some effort, they were |
|
|
710 | considered too unimportant to be supported in the encoder. The |
|
|
711 | decoder, however, will decode these values as shared values. |
|
|
712 | |
|
|
713 | 256, 25 (stringref-namespace, stringref, L |
585 | <http://cbor.schmorp.de/stringref>) |
714 | <http://cbor.schmorp.de/stringref>) |
586 | These tags are automatically decoded when encountered. They are only |
715 | These tags are automatically decoded when encountered. They are only |
587 | encoded, however, when "allow_stringref" is enabled. |
716 | encoded, however, when "pack_strings" is enabled. |
588 | |
717 | |
589 | 22098 (indirection, <http://cbor.schmorp.de/indirection>) |
718 | 22098 (indirection, <http://cbor.schmorp.de/indirection>) |
590 | This tag is automatically generated when a reference are encountered |
719 | This tag is automatically generated when a reference are encountered |
591 | (with the exception of hash and array refernces). It is converted to |
720 | (with the exception of hash and array refernces). It is converted to |
592 | a reference when decoding. |
721 | a reference when decoding. |
… | |
… | |
605 | |
734 | |
606 | When any of these need to load additional modules that are not part of |
735 | When any of these need to load additional modules that are not part of |
607 | the perl core distribution (e.g. URI), it is (currently) up to the user |
736 | the perl core distribution (e.g. URI), it is (currently) up to the user |
608 | to provide these modules. The decoding usually fails with an exception |
737 | to provide these modules. The decoding usually fails with an exception |
609 | if the required module cannot be loaded. |
738 | if the required module cannot be loaded. |
|
|
739 | |
|
|
740 | 0, 1 (date/time string, seconds since the epoch) |
|
|
741 | These tags are decoded into Time::Piece objects. The corresponding |
|
|
742 | "Time::Piece::TO_CBOR" method always encodes into tag 1 values |
|
|
743 | currently. |
|
|
744 | |
|
|
745 | The Time::Piece API is generally surprisingly bad, and fractional |
|
|
746 | seconds are only accidentally kept intact, so watch out. On the plus |
|
|
747 | side, the module comes with perl since 5.10, which has to count for |
|
|
748 | something. |
610 | |
749 | |
611 | 2, 3 (positive/negative bignum) |
750 | 2, 3 (positive/negative bignum) |
612 | These tags are decoded into Math::BigInt objects. The corresponding |
751 | These tags are decoded into Math::BigInt objects. The corresponding |
613 | "Math::BigInt::TO_CBOR" method encodes "small" bigints into normal |
752 | "Math::BigInt::TO_CBOR" method encodes "small" bigints into normal |
614 | CBOR integers, and others into positive/negative CBOR bignums. |
753 | CBOR integers, and others into positive/negative CBOR bignums. |
… | |
… | |
693 | uses long double to represent floating point values, they might not be |
832 | uses long double to represent floating point values, they might not be |
694 | encoded properly. Half precision types are accepted, but not encoded. |
833 | encoded properly. Half precision types are accepted, but not encoded. |
695 | |
834 | |
696 | Strict mode and canonical mode are not implemented. |
835 | Strict mode and canonical mode are not implemented. |
697 | |
836 | |
|
|
837 | LIMITATIONS ON PERLS WITHOUT 64-BIT INTEGER SUPPORT |
|
|
838 | On perls that were built without 64 bit integer support (these are rare |
|
|
839 | nowadays, even on 32 bit architectures), support for any kind of 64 bit |
|
|
840 | integer in CBOR is very limited - most likely, these 64 bit values will |
|
|
841 | be truncated, corrupted, or otherwise not decoded correctly. This also |
|
|
842 | includes string, array and map sizes that are stored as 64 bit integers. |
|
|
843 | |
698 | THREADS |
844 | THREADS |
699 | This module is *not* guaranteed to be thread safe and there are no plans |
845 | This module is *not* guaranteed to be thread safe and there are no plans |
700 | to change this until Perl gets thread support (as opposed to the |
846 | to change this until Perl gets thread support (as opposed to the |
701 | horribly slow so-called "threads" which are simply slow and bloated |
847 | horribly slow so-called "threads" which are simply slow and bloated |
702 | process simulations - use fork, it's *much* faster, cheaper, better). |
848 | process simulations - use fork, it's *much* faster, cheaper, better). |