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.104 by root, Thu May 8 15:33:06 2008 UTC vs.
Revision 1.105 by root, Sat May 24 21:55:43 2008 UTC

… …
37primary goal is to be I<correct> and its secondary goal is to be 37primary goal is to be I<correct> and its secondary goal is to be
38I<fast>. To reach the latter goal it was written in C. 38I<fast>. To reach the latter goal it was written in C.
39 39
40Beginning with version 2.0 of the JSON module, when both JSON and 40Beginning with version 2.0 of the JSON module, when both JSON and
41JSON::XS are installed, then JSON will fall back on JSON::XS (this can be 41JSON::XS are installed, then JSON will fall back on JSON::XS (this can be
42overriden) with no overhead due to emulation (by inheritign constructor 42overridden) with no overhead due to emulation (by inheriting constructor
43and methods). If JSON::XS is not available, it will fall back to the 43and methods). If JSON::XS is not available, it will fall back to the
44compatible JSON::PP module as backend, so using JSON instead of JSON::XS 44compatible JSON::PP module as backend, so using JSON instead of JSON::XS
45gives you a portable JSON API that can be fast when you need and doesn't 45gives you a portable JSON API that can be fast when you need and doesn't
46require a C compiler when that is a problem. 46require a C compiler when that is a problem.
47 47
… …
65This module knows how to handle Unicode, documents how and when it does 65This module knows how to handle Unicode, documents how and when it does
66so, and even documents what "correct" means. 66so, and even documents what "correct" means.
67 67
68=item * round-trip integrity 68=item * round-trip integrity
69 69
70When you serialise a perl data structure using only datatypes supported 70When you serialise a perl data structure using only data types supported
71by JSON, the deserialised data structure is identical on the Perl level. 71by JSON, the deserialised data structure is identical on the Perl level.
72(e.g. the string "2.0" doesn't suddenly become "2" just because it looks 72(e.g. the string "2.0" doesn't suddenly become "2" just because it looks
73like a number). There minor I<are> exceptions to this, read the MAPPING 73like a number). There minor I<are> exceptions to this, read the MAPPING
74section below to learn about those. 74section below to learn about those.
75 75
… …
84Compared to other JSON modules and other serialisers such as Storable, 84Compared to other JSON modules and other serialisers such as Storable,
85this module usually compares favourably in terms of speed, too. 85this module usually compares favourably in terms of speed, too.
86 86
87=item * simple to use 87=item * simple to use
88 88
89This module has both a simple functional interface as well as an objetc 89This module has both a simple functional interface as well as an object
90oriented interface interface. 90oriented interface interface.
91 91
92=item * reasonably versatile output formats 92=item * reasonably versatile output formats
93 93
94You can choose between the most compact guaranteed-single-line format 94You can choose between the most compact guaranteed-single-line format
95possible (nice for simple line-based protocols), a pure-ascii format 95possible (nice for simple line-based protocols), a pure-ASCII format
96(for when your transport is not 8-bit clean, still supports the whole 96(for when your transport is not 8-bit clean, still supports the whole
97Unicode range), or a pretty-printed format (for when you want to read that 97Unicode range), or a pretty-printed format (for when you want to read that
98stuff). Or you can combine those features in whatever way you like. 98stuff). Or you can combine those features in whatever way you like.
99 99
100=back 100=back
… …
137 137
138This function call is functionally identical to: 138This function call is functionally identical to:
139 139
140 $json_text = JSON::XS->new->utf8->encode ($perl_scalar) 140 $json_text = JSON::XS->new->utf8->encode ($perl_scalar)
141 141
142except being faster. 142Except being faster.
143 143
144=item $perl_scalar = decode_json $json_text 144=item $perl_scalar = decode_json $json_text
145 145
146The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries 146The opposite of C<encode_json>: expects an UTF-8 (binary) string and tries
147to parse that as an UTF-8 encoded JSON text, returning the resulting 147to parse that as an UTF-8 encoded JSON text, returning the resulting
… …
149 149
150This function call is functionally identical to: 150This function call is functionally identical to:
151 151
152 $perl_scalar = JSON::XS->new->utf8->decode ($json_text) 152 $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
153 153
154except being faster. 154Except being faster.
155 155
156=item $is_boolean = JSON::XS::is_bool $scalar 156=item $is_boolean = JSON::XS::is_bool $scalar
157 157
158Returns true if the passed scalar represents either JSON::XS::true or 158Returns true if the passed scalar represents either JSON::XS::true or
159JSON::XS::false, two constants that act like C<1> and C<0>, respectively 159JSON::XS::false, two constants that act like C<1> and C<0>, respectively
… …
197 197
198If you didn't know about that flag, just the better, pretend it doesn't 198If you didn't know about that flag, just the better, pretend it doesn't
199exist. 199exist.
200 200
201=item 4. A "Unicode String" is simply a string where each character can be 201=item 4. A "Unicode String" is simply a string where each character can be
202validly interpreted as a Unicode codepoint. 202validly interpreted as a Unicode code point.
203 203
204If you have UTF-8 encoded data, it is no longer a Unicode string, but a 204If you have UTF-8 encoded data, it is no longer a Unicode string, but a
205Unicode string encoded in UTF-8, giving you a binary string. 205Unicode string encoded in UTF-8, giving you a binary string.
206 206
207=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. 207=item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string.
… …
700 700
701=back 701=back
702 702
703 703
704=head1 INCREMENTAL PARSING 704=head1 INCREMENTAL PARSING
705
706[This section and the API it details is still EXPERIMENTAL]
707 705
708In some cases, there is the need for incremental parsing of JSON 706In some cases, there is the need for incremental parsing of JSON
709texts. While this module always has to keep both JSON text and resulting 707texts. While this module always has to keep both JSON text and resulting
710Perl data structure in memory at one time, it does allow you to parse a 708Perl data structure in memory at one time, it does allow you to parse a
711JSON stream incrementally. It does so by accumulating text until it has 709JSON stream incrementally. It does so by accumulating text until it has

Diff Legend

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