1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
|
|
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
4 | |
3 | =encoding utf-8 |
5 | =encoding utf-8 |
4 | |
|
|
5 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
6 | |
6 | |
7 | JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
7 | JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ |
8 | (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
8 | (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html) |
9 | |
9 | |
10 | =head1 SYNOPSIS |
10 | =head1 SYNOPSIS |
… | |
… | |
103 | |
103 | |
104 | package JSON::XS; |
104 | package JSON::XS; |
105 | |
105 | |
106 | use strict; |
106 | use strict; |
107 | |
107 | |
108 | our $VERSION = '2.1'; |
108 | our $VERSION = '2.2'; |
109 | our @ISA = qw(Exporter); |
109 | our @ISA = qw(Exporter); |
110 | |
110 | |
111 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
111 | our @EXPORT = qw(encode_json decode_json to_json from_json); |
112 | |
112 | |
113 | sub to_json($) { |
113 | sub to_json($) { |
… | |
… | |
462 | Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
462 | Example, encode a Perl scalar as JSON value with enabled C<allow_nonref>, |
463 | resulting in an invalid JSON text: |
463 | resulting in an invalid JSON text: |
464 | |
464 | |
465 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
465 | JSON::XS->new->allow_nonref->encode ("Hello, World!") |
466 | => "Hello, World!" |
466 | => "Hello, World!" |
|
|
467 | |
|
|
468 | =item $json = $json->allow_unknown ([$enable]) |
|
|
469 | |
|
|
470 | =item $enabled = $json->get_allow_unknown |
|
|
471 | |
|
|
472 | If C<$enable> is true (or missing), then C<encode> will I<not> throw an |
|
|
473 | exception when it encounters values it cannot represent in JSON (for |
|
|
474 | example, filehandles) but instead will encode a JSON C<null> value. Note |
|
|
475 | that blessed objects are not included here and are handled separately by |
|
|
476 | c<allow_nonref>. |
|
|
477 | |
|
|
478 | If C<$enable> is false (the default), then C<encode> will throw an |
|
|
479 | exception when it encounters anything it cannot encode as JSON. |
|
|
480 | |
|
|
481 | This option does not affect C<decode> in any way, and it is recommended to |
|
|
482 | leave it off unless you know your communications partner. |
467 | |
483 | |
468 | =item $json = $json->allow_blessed ([$enable]) |
484 | =item $json = $json->allow_blessed ([$enable]) |
469 | |
485 | |
470 | =item $enabled = $json->get_allow_blessed |
486 | =item $enabled = $json->get_allow_blessed |
471 | |
487 | |
… | |
… | |
612 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
628 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
613 | |
629 | |
614 | =item $max_depth = $json->get_max_depth |
630 | =item $max_depth = $json->get_max_depth |
615 | |
631 | |
616 | Sets the maximum nesting level (default C<512>) accepted while encoding |
632 | Sets the maximum nesting level (default C<512>) accepted while encoding |
617 | or decoding. If the JSON text or Perl data structure has an equal or |
633 | or decoding. If a higher nesting level is detected in JSON text or a Perl |
618 | higher nesting level then this limit, then the encoder and decoder will |
634 | data structure, then the encoder and decoder will stop and croak at that |
619 | stop and croak at that point. |
635 | point. |
620 | |
636 | |
621 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
637 | Nesting level is defined by number of hash- or arrayrefs that the encoder |
622 | needs to traverse to reach a given point or the number of C<{> or C<[> |
638 | needs to traverse to reach a given point or the number of C<{> or C<[> |
623 | characters without their matching closing parenthesis crossed to reach a |
639 | characters without their matching closing parenthesis crossed to reach a |
624 | given character in a string. |
640 | given character in a string. |
625 | |
641 | |
626 | Setting the maximum depth to one disallows any nesting, so that ensures |
642 | Setting the maximum depth to one disallows any nesting, so that ensures |
627 | that the object is only a single hash/object or array. |
643 | that the object is only a single hash/object or array. |
628 | |
644 | |
629 | The argument to C<max_depth> will be rounded up to the next highest power |
|
|
630 | of two. If no argument is given, the highest possible setting will be |
645 | If no argument is given, the highest possible setting will be used, which |
631 | used, which is rarely useful. |
646 | is rarely useful. |
|
|
647 | |
|
|
648 | Note that nesting is implemented by recursion in C. The default value has |
|
|
649 | been chosen to be as large as typical operating systems allow without |
|
|
650 | crashing. |
632 | |
651 | |
633 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
652 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
634 | |
653 | |
635 | =item $json = $json->max_size ([$maximum_string_size]) |
654 | =item $json = $json->max_size ([$maximum_string_size]) |
636 | |
655 | |
637 | =item $max_size = $json->get_max_size |
656 | =item $max_size = $json->get_max_size |
638 | |
657 | |
639 | Set the maximum length a JSON text may have (in bytes) where decoding is |
658 | Set the maximum length a JSON text may have (in bytes) where decoding is |
640 | being attempted. The default is C<0>, meaning no limit. When C<decode> |
659 | being attempted. The default is C<0>, meaning no limit. When C<decode> |
641 | is called on a string longer then this number of characters it will not |
660 | is called on a string that is longer then this many bytes, it will not |
642 | attempt to decode the string but throw an exception. This setting has no |
661 | attempt to decode the string but throw an exception. This setting has no |
643 | effect on C<encode> (yet). |
662 | effect on C<encode> (yet). |
644 | |
663 | |
645 | The argument to C<max_size> will be rounded up to the next B<highest> |
664 | If no argument is given, the limit check will be deactivated (same as when |
646 | power of two (so may be more than requested). If no argument is given, the |
665 | C<0> is specified). |
647 | limit check will be deactivated (same as when C<0> is specified). |
|
|
648 | |
666 | |
649 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
667 | See SECURITY CONSIDERATIONS, below, for more info on why this is useful. |
650 | |
668 | |
651 | =item $json_text = $json->encode ($perl_scalar) |
669 | =item $json_text = $json->encode ($perl_scalar) |
652 | |
670 | |
… | |
… | |
683 | =back |
701 | =back |
684 | |
702 | |
685 | |
703 | |
686 | =head1 INCREMENTAL PARSING |
704 | =head1 INCREMENTAL PARSING |
687 | |
705 | |
688 | [This section is still EXPERIMENTAL] |
706 | [This section and the API it details is still EXPERIMENTAL] |
689 | |
707 | |
690 | In some cases, there is the need for incremental parsing of JSON |
708 | In some cases, there is the need for incremental parsing of JSON |
691 | texts. While this module always has to keep both JSON text and resulting |
709 | texts. While this module always has to keep both JSON text and resulting |
692 | Perl data structure in memory at one time, it does allow you to parse a |
710 | Perl data structure in memory at one time, it does allow you to parse a |
693 | JSON stream incrementally. It does so by accumulating text until it has |
711 | JSON stream incrementally. It does so by accumulating text until it has |
… | |
… | |
1214 | |
1232 | |
1215 | First comes a comparison between various modules using |
1233 | First comes a comparison between various modules using |
1216 | a very short single-line JSON string (also available at |
1234 | a very short single-line JSON string (also available at |
1217 | L<http://dist.schmorp.de/misc/json/short.json>). |
1235 | L<http://dist.schmorp.de/misc/json/short.json>). |
1218 | |
1236 | |
1219 | {"method": "handleMessage", "params": ["user1", "we were just talking"], \ |
1237 | {"method": "handleMessage", "params": ["user1", |
1220 | "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} |
1238 | "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7, |
|
|
1239 | true, false]} |
1221 | |
1240 | |
1222 | It shows the number of encodes/decodes per second (JSON::XS uses |
1241 | It shows the number of encodes/decodes per second (JSON::XS uses |
1223 | the functional interface, while JSON::XS/2 uses the OO interface |
1242 | the functional interface, while JSON::XS/2 uses the OO interface |
1224 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1243 | with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables |
1225 | shrink). Higher is better: |
1244 | shrink). Higher is better: |
… | |
… | |
1323 | |
1342 | |
1324 | |
1343 | |
1325 | =head1 BUGS |
1344 | =head1 BUGS |
1326 | |
1345 | |
1327 | While the goal of this module is to be correct, that unfortunately does |
1346 | While the goal of this module is to be correct, that unfortunately does |
1328 | not mean it's bug-free, only that I think its design is bug-free. It is |
1347 | not mean it's bug-free, only that I think its design is bug-free. If you |
1329 | still relatively early in its development. If you keep reporting bugs they |
1348 | keep reporting bugs they will be fixed swiftly, though. |
1330 | will be fixed swiftly, though. |
|
|
1331 | |
1349 | |
1332 | Please refrain from using rt.cpan.org or any other bug reporting |
1350 | Please refrain from using rt.cpan.org or any other bug reporting |
1333 | service. I put the contact address into my modules for a reason. |
1351 | service. I put the contact address into my modules for a reason. |
1334 | |
1352 | |
1335 | =cut |
1353 | =cut |