|
|
1 | =encoding utf-8 |
|
|
2 | |
1 | =head1 NAME |
3 | =head1 NAME |
2 | |
4 | |
3 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
5 | JSON::XS - JSON serialising/deserialising, done correctly and fast |
|
|
6 | |
|
|
7 | JSON::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 | |
… | |
… | |
98 | |
103 | |
99 | =over 4 |
104 | =over 4 |
100 | |
105 | |
101 | =item $json_text = to_json $perl_scalar |
106 | =item $json_text = to_json $perl_scalar |
102 | |
107 | |
103 | Converts the given Perl data structure (a simple scalar or a reference to |
108 | Converts the given Perl data structure to a UTF-8 encoded, binary string |
104 | a hash or array) to a UTF-8 encoded, binary string (that is, the string contains |
109 | (that is, the string contains octets only). Croaks on error. |
105 | octets only). Croaks on error. |
|
|
106 | |
110 | |
107 | This function call is functionally identical to: |
111 | This function call is functionally identical to: |
108 | |
112 | |
109 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
113 | $json_text = JSON::XS->new->utf8->encode ($perl_scalar) |
110 | |
114 | |
111 | except being faster. |
115 | except being faster. |
112 | |
116 | |
113 | =item $perl_scalar = from_json $json_text |
117 | =item $perl_scalar = from_json $json_text |
114 | |
118 | |
115 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries to |
119 | The opposite of C<to_json>: expects an UTF-8 (binary) string and tries |
116 | parse that as an UTF-8 encoded JSON text, returning the resulting simple |
120 | to parse that as an UTF-8 encoded JSON text, returning the resulting |
117 | scalar or reference. Croaks on error. |
121 | reference. Croaks on error. |
118 | |
122 | |
119 | This function call is functionally identical to: |
123 | This function call is functionally identical to: |
120 | |
124 | |
121 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
125 | $perl_scalar = JSON::XS->new->utf8->decode ($json_text) |
122 | |
126 | |
… | |
… | |
130 | |
134 | |
131 | See MAPPING, below, for more information on how JSON values are mapped to |
135 | See MAPPING, below, for more information on how JSON values are mapped to |
132 | Perl. |
136 | Perl. |
133 | |
137 | |
134 | =back |
138 | =back |
|
|
139 | |
|
|
140 | |
|
|
141 | =head1 A FEW NOTES ON UNICODE AND PERL |
|
|
142 | |
|
|
143 | Since this often leads to confusion, here are a few very clear words on |
|
|
144 | how Unicode works in Perl, modulo bugs. |
|
|
145 | |
|
|
146 | =over 4 |
|
|
147 | |
|
|
148 | =item 1. Perl strings can store characters with ordinal values > 255. |
|
|
149 | |
|
|
150 | This enables you to store unicode characters as single characters in a |
|
|
151 | Perl string - very natural. |
|
|
152 | |
|
|
153 | =item 2. Perl does I<not> associate an encoding with your strings. |
|
|
154 | |
|
|
155 | Unless you force it to, e.g. when matching it against a regex, or printing |
|
|
156 | the scalar to a file, in which case Perl either interprets your string as |
|
|
157 | locale-encoded text, octets/binary, or as Unicode, depending on various |
|
|
158 | settings. In no case is an encoding stored together with your data, it is |
|
|
159 | I<use> that decides encoding, not any magical metadata. |
|
|
160 | |
|
|
161 | =item 3. The internal utf-8 flag has no meaning with regards to the |
|
|
162 | encoding of your string. |
|
|
163 | |
|
|
164 | Just ignore that flag unless you debug a Perl bug, a module written in |
|
|
165 | XS or want to dive into the internals of perl. Otherwise it will only |
|
|
166 | confuse you, as, despite the name, it says nothing about how your string |
|
|
167 | is encoded. You can have unicode strings with that flag set, with that |
|
|
168 | flag clear, and you can have binary data with that flag set and that flag |
|
|
169 | clear. Other possibilities exist, too. |
|
|
170 | |
|
|
171 | If you didn't know about that flag, just the better, pretend it doesn't |
|
|
172 | exist. |
|
|
173 | |
|
|
174 | =item 4. A "Unicode String" is simply a string where each character can be |
|
|
175 | validly interpreted as a Unicode codepoint. |
|
|
176 | |
|
|
177 | If you have UTF-8 encoded data, it is no longer a Unicode string, but a |
|
|
178 | Unicode string encoded in UTF-8, giving you a binary string. |
|
|
179 | |
|
|
180 | =item 5. A string containing "high" (> 255) character values is I<not> a UTF-8 string. |
|
|
181 | |
|
|
182 | Its a fact. Learn to live with it. |
|
|
183 | |
|
|
184 | =back |
|
|
185 | |
|
|
186 | I hope this helps :) |
135 | |
187 | |
136 | |
188 | |
137 | =head1 OBJECT-ORIENTED INTERFACE |
189 | =head1 OBJECT-ORIENTED INTERFACE |
138 | |
190 | |
139 | The object oriented interface lets you configure your own encoding or |
191 | The object oriented interface lets you configure your own encoding or |
… | |
… | |
666 | to_json [\0,JSON::XS::true] # yields [false,true] |
718 | to_json [\0,JSON::XS::true] # yields [false,true] |
667 | |
719 | |
668 | =item JSON::XS::true, JSON::XS::false |
720 | =item JSON::XS::true, JSON::XS::false |
669 | |
721 | |
670 | These special values become JSON true and JSON false values, |
722 | These special values become JSON true and JSON false values, |
671 | respectively. You cna alos use C<\1> and C<\0> directly if you want. |
723 | respectively. You can also use C<\1> and C<\0> directly if you want. |
672 | |
724 | |
673 | =item blessed objects |
725 | =item blessed objects |
674 | |
726 | |
675 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
727 | Blessed objects are not allowed. JSON::XS currently tries to encode their |
676 | underlying representation (hash- or arrayref), but this behaviour might |
728 | underlying representation (hash- or arrayref), but this behaviour might |
… | |
… | |
926 | design bugs, but it is still you who will have to deal with it, as major |
978 | design bugs, but it is still you who will have to deal with it, as major |
927 | browser developers care only for features, not about doing security |
979 | browser developers care only for features, not about doing security |
928 | right). |
980 | right). |
929 | |
981 | |
930 | |
982 | |
|
|
983 | =head1 THREADS |
|
|
984 | |
|
|
985 | This module is I<not> guarenteed to be thread safe and there are no |
|
|
986 | plans to change this until Perl gets thread support (as opposed to the |
|
|
987 | horribly slow so-called "threads" which are simply slow and bloated |
|
|
988 | process simulations - use fork, its I<much> faster, cheaper, better). |
|
|
989 | |
|
|
990 | (It might actually work, but you ahve ben warned). |
|
|
991 | |
|
|
992 | |
931 | =head1 BUGS |
993 | =head1 BUGS |
932 | |
994 | |
933 | While the goal of this module is to be correct, that unfortunately does |
995 | While the goal of this module is to be correct, that unfortunately does |
934 | not mean its bug-free, only that I think its design is bug-free. It is |
996 | not mean its bug-free, only that I think its design is bug-free. It is |
935 | still relatively early in its development. If you keep reporting bugs they |
997 | still relatively early in its development. If you keep reporting bugs they |
936 | will be fixed swiftly, though. |
998 | will be fixed swiftly, though. |
|
|
999 | |
|
|
1000 | Please refrain from using rt.cpan.org or any other bug reporting |
|
|
1001 | service. I put the contact address into my modules for a reason. |
937 | |
1002 | |
938 | =cut |
1003 | =cut |
939 | |
1004 | |
940 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
1005 | our $true = do { bless \(my $dummy = 1), "JSON::XS::Boolean" }; |
941 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |
1006 | our $false = do { bless \(my $dummy = 0), "JSON::XS::Boolean" }; |