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.55 by root, Mon Jul 23 22:57:40 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
… …
81 86
82package JSON::XS; 87package JSON::XS;
83 88
84use strict; 89use strict;
85 90
86our $VERSION = '1.42'; 91our $VERSION = '1.5';
87our @ISA = qw(Exporter); 92our @ISA = qw(Exporter);
88 93
89our @EXPORT = qw(to_json from_json); 94our @EXPORT = qw(to_json from_json);
90 95
91use Exporter; 96use Exporter;
… …
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.
… …
553are represented by the same codepoints in the Perl string, so no manual 603are represented by the same codepoints in the Perl string, so no manual
554decoding is necessary. 604decoding is necessary.
555 605
556=item number 606=item number
557 607
558A JSON number becomes either an integer or numeric (floating point) 608A JSON number becomes either an integer, numeric (floating point) or
559scalar in perl, depending on its range and any fractional parts. On the 609string scalar in perl, depending on its range and any fractional parts. On
560Perl level, there is no difference between those as Perl handles all the 610the Perl level, there is no difference between those as Perl handles all
561conversion details, but an integer may take slightly less memory and might 611the conversion details, but an integer may take slightly less memory and
562represent more values exactly than (floating point) numbers. 612might represent more values exactly than (floating point) numbers.
613
614If the number consists of digits only, JSON::XS will try to represent
615it as an integer value. If that fails, it will try to represent it as
616a numeric (floating point) value if that is possible without loss of
617precision. Otherwise it will preserve the number as a string value.
618
619Numbers containing a fractional or exponential part will always be
620represented as numeric (floating point) values, possibly at a loss of
621precision.
622
623This might create round-tripping problems as numbers might become strings,
624but as Perl is typeless there is no other way to do it.
563 625
564=item true, false 626=item true, false
565 627
566These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>, 628These JSON atoms become C<JSON::XS::true> and C<JSON::XS::false>,
567respectively. They are overloaded to act almost exactly like the numbers 629respectively. They are overloaded to act almost exactly like the numbers
… …
609 to_json [\0,JSON::XS::true] # yields [false,true] 671 to_json [\0,JSON::XS::true] # yields [false,true]
610 672
611=item JSON::XS::true, JSON::XS::false 673=item JSON::XS::true, JSON::XS::false
612 674
613These special values become JSON true and JSON false values, 675These special values become JSON true and JSON false values,
614respectively. 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.
615 677
616=item blessed objects 678=item blessed objects
617 679
618Blessed objects are not allowed. JSON::XS currently tries to encode their 680Blessed objects are not allowed. JSON::XS currently tries to encode their
619underlying 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