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 |
… | |
… | |
628 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
628 | =item $json = $json->max_depth ([$maximum_nesting_depth]) |
629 | |
629 | |
630 | =item $max_depth = $json->get_max_depth |
630 | =item $max_depth = $json->get_max_depth |
631 | |
631 | |
632 | Sets the maximum nesting level (default C<512>) accepted while encoding |
632 | Sets the maximum nesting level (default C<512>) accepted while encoding |
633 | 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 |
634 | 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 |
635 | stop and croak at that point. |
635 | point. |
636 | |
636 | |
637 | 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 |
638 | 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<[> |
639 | characters without their matching closing parenthesis crossed to reach a |
639 | characters without their matching closing parenthesis crossed to reach a |
640 | given character in a string. |
640 | given character in a string. |
641 | |
641 | |
642 | 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 |
643 | that the object is only a single hash/object or array. |
643 | that the object is only a single hash/object or array. |
644 | |
644 | |
645 | The argument to C<max_depth> will be rounded up to the next highest power |
|
|
646 | 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 |
647 | 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. |
648 | |
651 | |
649 | 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. |
650 | |
653 | |
651 | =item $json = $json->max_size ([$maximum_string_size]) |
654 | =item $json = $json->max_size ([$maximum_string_size]) |
652 | |
655 | |
653 | =item $max_size = $json->get_max_size |
656 | =item $max_size = $json->get_max_size |
654 | |
657 | |
655 | 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 |
656 | 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> |
657 | 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 |
658 | 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 |
659 | effect on C<encode> (yet). |
662 | effect on C<encode> (yet). |
660 | |
663 | |
661 | 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 |
662 | power of two (so may be more than requested). If no argument is given, the |
665 | C<0> is specified). |
663 | limit check will be deactivated (same as when C<0> is specified). |
|
|
664 | |
666 | |
665 | 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. |
666 | |
668 | |
667 | =item $json_text = $json->encode ($perl_scalar) |
669 | =item $json_text = $json->encode ($perl_scalar) |
668 | |
670 | |
… | |
… | |
1340 | |
1342 | |
1341 | |
1343 | |
1342 | =head1 BUGS |
1344 | =head1 BUGS |
1343 | |
1345 | |
1344 | 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 |
1345 | 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 |
1346 | still relatively early in its development. If you keep reporting bugs they |
1348 | keep reporting bugs they will be fixed swiftly, though. |
1347 | will be fixed swiftly, though. |
|
|
1348 | |
1349 | |
1349 | 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 |
1350 | 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. |
1351 | |
1352 | |
1352 | =cut |
1353 | =cut |