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.32 by root, Thu Apr 12 07:25:29 2007 UTC vs.
Revision 1.37 by root, Wed Jun 6 14:52:49 2007 UTC

… …
86package JSON::XS; 86package JSON::XS;
87 87
88use strict; 88use strict;
89 89
90BEGIN { 90BEGIN {
91 our $VERSION = '1.12'; 91 our $VERSION = '1.22';
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
… …
159as per RFC4627. The resulting encoded JSON text can be treated as a native 159as per RFC4627. The resulting encoded JSON text can be treated as a native
160unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string, 160unicode string, an ascii-encoded, latin1-encoded or UTF-8 encoded string,
161or any other superset of ASCII. 161or any other superset of ASCII.
162 162
163If C<$enable> is false, then the C<encode> method will not escape Unicode 163If C<$enable> is false, then the C<encode> method will not escape Unicode
164characters unless required by the JSON syntax. This results in a faster 164characters unless required by the JSON syntax or other flags. This results
165and more compact format. 165in a faster and more compact format.
166
167The main use for this flag is to produce JSON texts that can be
168transmitted over a 7-bit channel, as the encoded JSON texts will not
169contain any 8 bit characters.
166 170
167 JSON::XS->new->ascii (1)->encode ([chr 0x10401]) 171 JSON::XS->new->ascii (1)->encode ([chr 0x10401])
168 => ["\ud801\udc01"] 172 => ["\ud801\udc01"]
173
174=item $json = $json->latin1 ([$enable])
175
176If C<$enable> is true (or missing), then the C<encode> method will encode
177the resulting JSON text as latin1 (or iso-8859-1), escaping any characters
178outside the code range C<0..255>. The resulting string can be treated as a
179latin1-encoded JSON text or a native unicode string. The C<decode> method
180will not be affected in any way by this flag, as C<decode> by default
181expects unicode, which is a strict superset of latin1.
182
183If C<$enable> is false, then the C<encode> method will not escape Unicode
184characters unless required by the JSON syntax or other flags.
185
186The main use for this flag is efficiently encoding binary data as JSON
187text, as most octets will not be escaped, resulting in a smaller encoded
188size. The disadvantage is that the resulting JSON text is encoded
189in latin1 (and must correctly be treated as such when storing and
190transfering), a rare encoding for JSON. It is therefore most useful when
191you want to store data structures known to contain binary data efficiently
192in files or databases, not when talking to other JSON encoders/decoders.
193
194 JSON::XS->new->latin1->encode (["\x{89}\x{abc}"]
195 => ["\x{89}\\u0abc"] # (perl syntax, U+abc escaped, U+89 not)
169 196
170=item $json = $json->utf8 ([$enable]) 197=item $json = $json->utf8 ([$enable])
171 198
172If C<$enable> is true (or missing), then the C<encode> method will encode 199If C<$enable> is true (or missing), then the C<encode> method will encode
173the JSON result into UTF-8, as required by many protocols, while the 200the JSON result into UTF-8, as required by many protocols, while the
… …
347 374
348JSON numbers and strings become simple Perl scalars. JSON arrays become 375JSON numbers and strings become simple Perl scalars. JSON arrays become
349Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes 376Perl arrayrefs and JSON objects become Perl hashrefs. C<true> becomes
350C<1>, C<false> becomes C<0> and C<null> becomes C<undef>. 377C<1>, C<false> becomes C<0> and C<null> becomes C<undef>.
351 378
379=item ($perl_scalar, $characters) = $json->decode_prefix ($json_text)
380
381This works like the C<decode> method, but instead of raising an exception
382when there is trailing garbage after the first JSON object, it will
383silently stop parsing there and return the number of characters consumed
384so far.
385
386This is useful if your JSON texts are not delimited by an outer protocol
387(which is not the brightest thing to do in the first place) and you need
388to know where the JSON text ends.
389
390 JSON::XS->new->decode_prefix ("[1] the tail")
391 => ([], 3)
392
352=back 393=back
353 394
354 395
355=head1 MAPPING 396=head1 MAPPING
356 397
… …
571It seems that JSON::XS is surprisingly fast, as shown in the following 612It seems that JSON::XS is surprisingly fast, as shown in the following
572tables. They have been generated with the help of the C<eg/bench> program 613tables. They have been generated with the help of the C<eg/bench> program
573in the JSON::XS distribution, to make it easy to compare on your own 614in the JSON::XS distribution, to make it easy to compare on your own
574system. 615system.
575 616
576First comes a comparison between various modules using a very short JSON 617First comes a comparison between various modules using a very short
577string: 618single-line JSON string:
578 619
579 {"method": "handleMessage", "params": ["user1", "we were just talking"], "id": null} 620 {"method": "handleMessage", "params": ["user1", "we were just talking"], \
621 "id": null, [1,11,234,-5,1e5,1e7, true, false]}
580 622
581It shows the number of encodes/decodes per second (JSON::XS uses the 623It shows the number of encodes/decodes per second (JSON::XS uses the
582functional interface, while JSON::XS/2 uses the OO interface with 624functional interface, while JSON::XS/2 uses the OO interface with
583pretty-printing and hashkey sorting enabled). Higher is better: 625pretty-printing and hashkey sorting enabled). Higher is better:
584 626
627 -----------+------------+------------+
585 module | encode | decode | 628 module | encode | decode |
586 -----------|------------|------------| 629 -----------|------------|------------|
587 JSON | 11488.516 | 7823.035 | 630 JSON | 10597.029 | 5740.903 |
588 JSON::DWIW | 94708.054 | 129094.260 | 631 JSON::DWIW | 78251.940 | 98457.840 |
589 JSON::PC | 63884.157 | 128528.212 | 632 JSON::PC | 70611.178 | 92794.336 |
590 JSON::Syck | 34898.677 | 42096.911 | 633 JSON::Syck | 28767.517 | 38199.490 |
591 JSON::XS | 654027.064 | 396423.669 | 634 JSON::XS | 419430.400 | 265462.278 |
592 JSON::XS/2 | 371564.190 | 371725.613 | 635 JSON::XS/2 | 279620.267 | 265462.278 |
636 JSON::XS/3 | 388361.481 | 265462.278 |
637 Storable | 16294.887 | 16844.594 |
593 -----------+------------+------------+ 638 -----------+------------+------------+
594 639
595That is, JSON::XS is more than six times faster than JSON::DWIW on 640That is, JSON::XS is about five times faster than JSON::DWIW on encoding,
596encoding, more than three times faster on decoding, and about thirty times 641about three times faster on decoding, and about fourty times faster
597faster than JSON, even with pretty-printing and key sorting. 642than JSON, even with pretty-printing and key sorting. It also compares
643favourably to Storable for small amounts of data.
598 644
599Using a longer test string (roughly 18KB, generated from Yahoo! Locals 645Using a longer test string (roughly 18KB, generated from Yahoo! Locals
600search API (http://nanoref.com/yahooapis/mgPdGg): 646search API (http://nanoref.com/yahooapis/mgPdGg):
601 647
602 module | encode | decode | 648 module | encode | decode |
603 -----------|------------|------------| 649 -----------|------------|------------|
604 JSON | 273.023 | 44.674 | 650 JSON | 254.685 | 37.665 |
605 JSON::DWIW | 1089.383 | 1145.704 | 651 JSON::DWIW | 1014.244 | 1087.678 |
606 JSON::PC | 3097.419 | 2393.921 | 652 JSON::PC | 3602.116 | 2307.352 |
607 JSON::Syck | 514.060 | 843.053 | 653 JSON::Syck | 558.035 | 776.263 |
608 JSON::XS | 6479.668 | 3636.364 | 654 JSON::XS | 5747.196 | 3543.684 |
609 JSON::XS/2 | 3774.221 | 3599.124 | 655 JSON::XS/2 | 3968.121 | 3589.170 |
656 JSON::XS/3 | 6105.246 | 3561.134 |
657 Storable | 4456.337 | 5320.020 |
610 -----------+------------+------------+ 658 -----------+------------+------------+
611 659
612Again, JSON::XS leads by far. 660Again, JSON::XS leads by far.
613 661
614On large strings containing lots of high unicode characters, some modules 662On large strings containing lots of high unicode characters, some modules

Diff Legend

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