ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/JSON-XS/XS.pm
(Generate patch)

Comparing JSON-XS/XS.pm (file contents):
Revision 1.38 by root, Wed Jun 6 18:16:52 2007 UTC vs.
Revision 1.40 by root, Mon Jun 11 03:42:57 2007 UTC

… …
86package JSON::XS; 86package JSON::XS;
87 87
88use strict; 88use strict;
89 89
90BEGIN { 90BEGIN {
91 our $VERSION = '1.23'; 91 our $VERSION = '1.24';
92 our @ISA = qw(Exporter); 92 our @ISA = qw(Exporter);
93 93
94 our @EXPORT = qw(to_json from_json objToJson jsonToObj); 94 our @EXPORT = qw(to_json from_json objToJson jsonToObj);
95 require Exporter; 95 require Exporter;
96 96
… …
402 402
403For the more enlightened: note that in the following descriptions, 403For the more enlightened: note that in the following descriptions,
404lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl> 404lowercase I<perl> refers to the Perl interpreter, while uppcercase I<Perl>
405refers to the abstract Perl language itself. 405refers to the abstract Perl language itself.
406 406
407
407=head2 JSON -> PERL 408=head2 JSON -> PERL
408 409
409=over 4 410=over 4
410 411
411=item object 412=item object
… …
441=item null 442=item null
442 443
443A JSON null atom becomes C<undef> in Perl. 444A JSON null atom becomes C<undef> in Perl.
444 445
445=back 446=back
447
446 448
447=head2 PERL -> JSON 449=head2 PERL -> JSON
448 450
449The mapping from Perl to JSON is slightly more difficult, as Perl is a 451The mapping from Perl to JSON is slightly more difficult, as Perl is a
450truly typeless language, so we can only guess which JSON type is meant by 452truly typeless language, so we can only guess which JSON type is meant by
… …
605 607
606Does not check input for validity. 608Does not check input for validity.
607 609
608=back 610=back
609 611
612
613=head2 JSON and YAML
614
615You often hear that JSON is a subset (or a close subset) of YAML. This is,
616however, a mass hysteria and very far from the truth. In general, there is
617no way to configure JSON::XS to output a data structure as valid YAML.
618
619If you really must use JSON::XS to generate YAML, you should this
620algorithm (subject to change in future versions):
621
622 my $to_yaml = JSON::XS->new->utf8->space_after (1);
623 my $yaml = $to_yaml->encode ($ref) . "\n";
624
625This will usually generate JSON texts that also parse as valid
626YAML. Please note that YAML has hardcoded limits on object key lengths
627that JSON doesn't have, so you should make sure that your hash keys are
628noticably shorter than 1024 characters.
629
630There might be other incompatibilities that I am not aware of. In general
631you should not try to generate YAML with a JSON generator or vice versa,
632or try to parse JSON with a YAML parser or vice versa.
633
634
610=head2 SPEED 635=head2 SPEED
611 636
612It seems that JSON::XS is surprisingly fast, as shown in the following 637It seems that JSON::XS is surprisingly fast, as shown in the following
613tables. They have been generated with the help of the C<eg/bench> program 638tables. They have been generated with the help of the C<eg/bench> program
614in the JSON::XS distribution, to make it easy to compare on your own 639in the JSON::XS distribution, to make it easy to compare on your own
… …
618single-line JSON string: 643single-line JSON string:
619 644
620 {"method": "handleMessage", "params": ["user1", "we were just talking"], \ 645 {"method": "handleMessage", "params": ["user1", "we were just talking"], \
621 "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]} 646 "id": null, "array":[1,11,234,-5,1e5,1e7, true, false]}
622 647
623It shows the number of encodes/decodes per second (JSON::XS uses the 648It shows the number of encodes/decodes per second (JSON::XS uses
624functional interface, while JSON::XS/2 uses the OO interface with 649the functional interface, while JSON::XS/2 uses the OO interface
625pretty-printing and hashkey sorting enabled). Higher is better: 650with pretty-printing and hashkey sorting enabled, JSON::XS/3 enables
651shrink). Higher is better:
626 652
627 module | encode | decode | 653 module | encode | decode |
628 -----------|------------|------------| 654 -----------|------------|------------|
629 JSON | 7645.468 | 4208.613 | 655 JSON | 7645.468 | 4208.613 |
630 JSON::DWIW | 68534.379 | 79437.576 | 656 JSON::DWIW | 40721.398 | 77101.176 |
631 JSON::PC | 65948.176 | 78251.940 | 657 JSON::PC | 65948.176 | 78251.940 |
632 JSON::Syck | 23379.621 | 28416.694 | 658 JSON::Syck | 22844.793 | 26479.192 |
633 JSON::XS | 388361.481 | 199728.762 | 659 JSON::XS | 388361.481 | 199728.762 |
634 JSON::XS/2 | 218453.333 | 192399.266 | 660 JSON::XS/2 | 218453.333 | 192399.266 |
635 JSON::XS/3 | 338250.323 | 192399.266 | 661 JSON::XS/3 | 338250.323 | 192399.266 |
636 Storable | 15732.573 | 28571.553 | 662 Storable | 15779.925 | 14169.946 |
637 -----------+------------+------------+ 663 -----------+------------+------------+
638 664
639That is, JSON::XS is about five times faster than JSON::DWIW on encoding, 665That is, JSON::XS is about five times faster than JSON::DWIW on encoding,
640about three times faster on decoding, and over fourty times faster 666about three times faster on decoding, and over fourty times faster
641than JSON, even with pretty-printing and key sorting. It also compares 667than JSON, even with pretty-printing and key sorting. It also compares
… …
645search API (http://nanoref.com/yahooapis/mgPdGg): 671search API (http://nanoref.com/yahooapis/mgPdGg):
646 672
647 module | encode | decode | 673 module | encode | decode |
648 -----------|------------|------------| 674 -----------|------------|------------|
649 JSON | 254.685 | 37.665 | 675 JSON | 254.685 | 37.665 |
650 JSON::DWIW | 1014.244 | 1087.678 | 676 JSON::DWIW | 843.343 | 1049.731 |
651 JSON::PC | 3602.116 | 2307.352 | 677 JSON::PC | 3602.116 | 2307.352 |
652 JSON::Syck | 558.035 | 776.263 | 678 JSON::Syck | 505.107 | 787.899 |
653 JSON::XS | 5747.196 | 3543.684 | 679 JSON::XS | 5747.196 | 3690.220 |
654 JSON::XS/2 | 3968.121 | 3589.170 | 680 JSON::XS/2 | 3968.121 | 3676.634 |
655 JSON::XS/3 | 6105.246 | 3561.134 | 681 JSON::XS/3 | 6105.246 | 3662.508 |
656 Storable | 4456.337 | 5320.020 | 682 Storable | 4417.337 | 5285.161 |
657 -----------+------------+------------+ 683 -----------+------------+------------+
658 684
659Again, JSON::XS leads by far. 685Again, JSON::XS leads by far (except for Storable which non-surprisingly
686decodes faster).
660 687
661On large strings containing lots of high unicode characters, some modules 688On large strings containing lots of high unicode characters, some modules
662(such as JSON::PC) seem to decode faster than JSON::XS, but the result 689(such as JSON::PC) seem to decode faster than JSON::XS, but the result
663will be broken due to missing (or wrong) unicode handling. Others refuse 690will be broken due to missing (or wrong) unicode handling. Others refuse
664to decode or encode properly, so it was impossible to prepare a fair 691to decode or encode properly, so it was impossible to prepare a fair

Diff Legend

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