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.58 by root, Sun Aug 26 21:56:47 2007 UTC vs.
Revision 1.62 by root, Thu Oct 11 22:52:52 2007 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3JSON::XS - JSON serialising/deserialising, done correctly and fast 5JSON::XS - JSON serialising/deserialising, done correctly and fast
6
7JSON::XS - 正しくて高速な JSON シリアライザ/デシリアライザ
8 (http://fleur.hio.jp/perldoc/mix/lib/JSON/XS.html)
4 9
5=head1 SYNOPSIS 10=head1 SYNOPSIS
6 11
7 use JSON::XS; 12 use JSON::XS;
8 13
277This setting has no effect when decoding JSON texts. 282This setting has no effect when decoding JSON texts.
278 283
279Example, space_before and indent disabled, space_after enabled: 284Example, space_before and indent disabled, space_after enabled:
280 285
281 {"key": "value"} 286 {"key": "value"}
287
288=item $json = $json->relaxed ([$enable])
289
290If C<$enable> is true (or missing), then C<decode> will accept some
291extensions to normal JSON syntax (see below). C<encode> will not be
292affected in anyway. I<Be aware that this option makes you accept invalid
293JSON texts as if they were valid!>. I suggest only to use this option to
294parse application-specific files written by humans (configuration files,
295resource files etc.)
296
297If C<$enable> is false (the default), then C<decode> will only accept
298valid JSON texts.
299
300Currently accepted extensions are:
301
302=over 4
303
304=item * list items can have an end-comma
305
306JSON I<separates> array elements and key-value pairs with commas. This
307can be annoying if you write JSON texts manually and want to be able to
308quickly append elements, so this extension accepts comma at the end of
309such items not just between them:
310
311 [
312 1,
313 2, <- this comma not normally allowed
314 ]
315 {
316 "k1": "v1",
317 "k2": "v2", <- this comma not normally allowed
318 }
319
320=item * shell-style '#'-comments
321
322Whenever JSON allows whitespace, shell-style comments are additionally
323allowed. They are terminated by the first carriage-return or line-feed
324character, after which more white-space and comments are allowed.
325
326 [
327 1, # this comment not allowed in JSON
328 # neither this one...
329 ]
330
331=back
282 332
283=item $json = $json->canonical ([$enable]) 333=item $json = $json->canonical ([$enable])
284 334
285If C<$enable> is true (or missing), then the C<encode> method will output JSON objects 335If C<$enable> is true (or missing), then the C<encode> method will output JSON objects
286by sorting their keys. This is adding a comparatively high overhead. 336by sorting their keys. This is adding a comparatively high overhead.
621 to_json [\0,JSON::XS::true] # yields [false,true] 671 to_json [\0,JSON::XS::true] # yields [false,true]
622 672
623=item JSON::XS::true, JSON::XS::false 673=item JSON::XS::true, JSON::XS::false
624 674
625These special values become JSON true and JSON false values, 675These special values become JSON true and JSON false values,
626respectively. You cna alos use C<\1> and C<\0> directly if you want. 676respectively. You can also use C<\1> and C<\0> directly if you want.
627 677
628=item blessed objects 678=item blessed objects
629 679
630Blessed objects are not allowed. JSON::XS currently tries to encode their 680Blessed objects are not allowed. JSON::XS currently tries to encode their
631underlying representation (hash- or arrayref), but this behaviour might 681underlying representation (hash- or arrayref), but this behaviour might

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines