[ViewVC] Diff of: cvs/JSON-XS/README

Comparing JSON-XS/README (file contents):
Revision 1.4 by root, Fri Mar 23 18:33:50 2007 UTC vs.
Revision 1.6 by root, Sat Mar 24 19:42:14 2007 UTC

         When you serialise a perl data structure using only datatypes
         supported by JSON, the deserialised data structure is identical on
         the Perl level. (e.g. the string "2.0" doesn't suddenly become "2").
     * strict checking of JSON correctness
-        There is no guessing, no generating of illegal JSON strings by
+        There is no guessing, no generating of illegal JSON texts by
         default, and only JSON is accepted as input by default (the latter
         is a security feature).
     * fast
         Compared to other JSON modules, this module compares favourably in
 FUNCTIONAL INTERFACE
     The following convinience methods are provided by this module. They are
     exported by default:
-    $json_string = to_json $perl_scalar
+    $json_text = to_json $perl_scalar
         Converts the given Perl data structure (a simple scalar or a
         reference to a hash or array) to a UTF-8 encoded, binary string
         (that is, the string contains octets only). Croaks on error.
-        This function call is functionally identical to
+        This function call is functionally identical to:
-        "JSON::XS->new->utf8->encode ($perl_scalar)".
+           $json_text = JSON::XS->new->utf8->encode ($perl_scalar)
+        except being faster.
-    $perl_scalar = from_json $json_string
+    $perl_scalar = from_json $json_text
         The opposite of "to_json": expects an UTF-8 (binary) string and
-        tries to parse that as an UTF-8 encoded JSON string, returning the
+        tries to parse that as an UTF-8 encoded JSON text, returning the
         resulting simple scalar or reference. Croaks on error.
-        This function call is functionally identical to
+        This function call is functionally identical to:
-        "JSON::XS->new->utf8->decode ($json_string)".
+           $perl_scalar = JSON::XS->new->utf8->decode ($json_text)
+        except being faster.
 OBJECT-ORIENTED INTERFACE
     The object oriented interface lets you configure your own encoding or
     decoding style, within the limits of supported formats.
         *disabled*.
         The mutators for flags all return the JSON object again and thus
         calls can be chained:
-           my $json = JSON::XS->new->utf8(1)->space_after(1)->encode ({a => [1,2]})
+           my $json = JSON::XS->new->utf8->space_after->encode ({a => [1,2]})
            => {"a": [1, 2]}
     $json = $json->ascii ([$enable])
         If $enable is true (or missing), then the "encode" method will not
-        generate characters outside the code range 0..127. Any unicode
+        generate characters outside the code range 0..127 (which is ASCII).
-        characters outside that range will be escaped using either a single
+        Any unicode characters outside that range will be escaped using
-        \uXXXX (BMP characters) or a double \uHHHH\uLLLLL escape sequence,
+        either a single \uXXXX (BMP characters) or a double \uHHHH\uLLLLL
-        as per RFC4627.
+        escape sequence, as per RFC4627.
         If $enable is false, then the "encode" method will not escape
-        Unicode characters unless necessary.
+        Unicode characters unless required by the JSON syntax. This results
+        in a faster and more compact format.
-          JSON::XS->new->ascii (1)->encode (chr 0x10401)
+          JSON::XS->new->ascii (1)->encode ([chr 0x10401])
-          => \ud801\udc01
+          => ["\ud801\udc01"]
     $json = $json->utf8 ([$enable])
         If $enable is true (or missing), then the "encode" method will
-        encode the JSON string into UTF-8, as required by many protocols,
+        encode the JSON result into UTF-8, as required by many protocols,
         while the "decode" method expects to be handled an UTF-8-encoded
         string. Please note that UTF-8-encoded strings do not contain any
         characters outside the range 0..255, they are thus useful for
-        bytewise/binary I/O.
+        bytewise/binary I/O. In future versions, enabling this option might
+        enable autodetection of the UTF-16 and UTF-32 encoding families, as
+        described in RFC4627.
         If $enable is false, then the "encode" method will return the JSON
         string as a (non-encoded) unicode string, while "decode" expects
         thus a unicode string. Any decoding or encoding (e.g. to UTF-8 or
         UTF-16) needs to be done yourself, e.g. using the Encode module.
-        Example, output UTF-16-encoded JSON:
+        Example, output UTF-16BE-encoded JSON:
+          use Encode;
+          $jsontext = encode "UTF-16BE", JSON::XS->new->encode ($object);
+        Example, decode UTF-32LE-encoded JSON:
+          use Encode;
+          $object = JSON::XS->new->decode (decode "UTF-32LE", $jsontext);
     $json = $json->pretty ([$enable])
         This enables (or disables) all of the "indent", "space_before" and
         "space_after" (and in the future possibly more) flags in one call to
         generate the most readable (or most compact) form possible.
         multiline format as output, putting every array member or
         object/hash key-value pair into its own line, identing them
         properly.
         If $enable is false, no newlines or indenting will be produced, and
-        the resulting JSON strings is guarenteed not to contain any
+        the resulting JSON text is guarenteed not to contain any "newlines".
-        "newlines".
-        This setting has no effect when decoding JSON strings.
+        This setting has no effect when decoding JSON texts.
     $json = $json->space_before ([$enable])
         If $enable is true (or missing), then the "encode" method will add
         an extra optional space before the ":" separating keys from values
         in JSON objects.
         If $enable is false, then the "encode" method will not add any extra
         space at those places.
-        This setting has no effect when decoding JSON strings. You will also
+        This setting has no effect when decoding JSON texts. You will also
         most likely combine this setting with "space_after".
         Example, space_before enabled, space_after and indent disabled:
            {"key" :"value"}
         pairs and array members.
         If $enable is false, then the "encode" method will not add any extra
         space at those places.
-        This setting has no effect when decoding JSON strings.
+        This setting has no effect when decoding JSON texts.
         Example, space_before and indent disabled, space_after enabled:
            {"key": "value"}
         If $enable is false, then the "encode" method will output key-value
         pairs in the order Perl stores them (which will likely change
         between runs of the same script).
         This option is useful if you want the same data structure to be
-        encoded as the same JSON string (given the same overall settings).
+        encoded as the same JSON text (given the same overall settings). If
-        If it is disabled, the same hash migh be encoded differently even if
+        it is disabled, the same hash migh be encoded differently even if
         contains the same data, as key-value pairs have no inherent ordering
         in Perl.
-        This setting has no effect when decoding JSON strings.
+        This setting has no effect when decoding JSON texts.
     $json = $json->allow_nonref ([$enable])
         If $enable is true (or missing), then the "encode" method can
         convert a non-reference into its corresponding string, number or
         null JSON value, which is an extension to RFC4627. Likewise,
         "decode" will accept those JSON values instead of croaking.
         If $enable is false, then the "encode" method will croak if it isn't
-        passed an arrayref or hashref, as JSON strings must either be an
+        passed an arrayref or hashref, as JSON texts must either be an
         object or array. Likewise, "decode" will croak if given something
         that is not a JSON object or array.
         Example, encode a Perl scalar as JSON value with enabled
         "allow_nonref", resulting in an invalid JSON text:
     $json = $json->shrink ([$enable])
         Perl usually over-allocates memory a bit when allocating space for
         strings. This flag optionally resizes strings generated by either
         "encode" or "decode" to their minimum size possible. This can save
-        memory when your JSON strings are either very very long or you have
+        memory when your JSON texts are either very very long or you have
         many short strings. It will also try to downgrade any strings to
         octet-form if possible: perl stores strings internally either in an
         encoding called UTF-X or in octet-form. The latter cannot store
         everything but uses less space in general.
         In the future, this setting might control other things, such as
         converting strings that look like integers or floats into integers
         or floats internally (there is no difference on the Perl level),
         saving space.
-    $json_string = $json->encode ($perl_scalar)
+    $json_text = $json->encode ($perl_scalar)
         Converts the given Perl data structure (a simple scalar or a
         reference to a hash or array) to its JSON representation. Simple
         scalars will be converted into JSON string or number sequences,
         while references to arrays become JSON arrays and references to
         hashes become JSON objects. Undefined Perl values (e.g. "undef")
         become JSON "null" values. Neither "true" nor "false" values will be
         generated.
-    $perl_scalar = $json->decode ($json_string)
+    $perl_scalar = $json->decode ($json_text)
-        The opposite of "encode": expects a JSON string and tries to parse
+        The opposite of "encode": expects a JSON text and tries to parse it,
-        it, returning the resulting simple scalar or reference. Croaks on
+        returning the resulting simple scalar or reference. Croaks on error.
-        error.
         JSON numbers and strings become simple Perl scalars. JSON arrays
         become Perl arrayrefs and JSON objects become Perl hashrefs. "true"
         becomes 1, "false" becomes 0 and "null" becomes "undef".
     refers to the abstract Perl language itself.
   JSON -> PERL
     object
         A JSON object becomes a reference to a hash in Perl. No ordering of
-        object keys is preserved.
+        object keys is preserved (JSON does not preserver object key
+        ordering itself).
     array
         A JSON array becomes a reference to an array in Perl.
     string
     hash references
         Perl hash references become JSON objects. As there is no inherent
         ordering in hash keys, they will usually be encoded in a
         pseudo-random order that can change between runs of the same program
-        but stays generally the same within the single run of a program.
+        but stays generally the same within a single run of a program.
         JSON::XS can optionally sort the hash keys (determined by the
         *canonical* flag), so the same datastructure will serialise to the
         same JSON text (given same settings and version of JSON::XS), but
         this incurs a runtime overhead.
         Has problems handling many Perl values (e.g. regex results and other
         magic values will make it croak).
         Does not even generate valid JSON ("{1,2}" gets converted to "{1:2}"
-        which is not a valid JSON string.
+        which is not a valid JSON text.
         Unmaintained (maintainer unresponsive for many months, bugs are not
         getting fixed).
     JSON::Syck 0.21
         Very buggy (often crashes).
         Very inflexible (no human-readable format supported, format pretty
         much undocumented. I need at least a format for easy reading by
         humans and a single-line compact format for use in a protocol, and
-        preferably a way to generate ASCII-only JSON strings).
+        preferably a way to generate ASCII-only JSON texts).
         Completely broken (and confusingly documented) Unicode handling
         (unicode escapes are not working properly, you need to set
         ImplicitUnicode to *different* values on en- and decoding to get
         symmetric behaviour).
         Very inflexible.
         No roundtripping.
-        Does not generate valid JSON (key strings are often unquoted, empty
+        Does not generate valid JSON texts (key strings are often unquoted,
-        keys result in nothing being output)
+        empty keys result in nothing being output)
         Does not check input for validity.
   SPEED
     It seems that JSON::XS is surprisingly fast, as shown in the following
     tables. They have been generated with the help of the "eg/bench" program
     in the JSON::XS distribution, to make it easy to compare on your own
     system.
-    First is a comparison between various modules using a very simple JSON
+    First comes a comparison between various modules using a very short JSON
-    string, showing the number of encodes/decodes per second (JSON::XS is
+    string (83 bytes), showing the number of encodes/decodes per second
-    the functional interface, while JSON::XS/2 is the OO interface with
+    (JSON::XS is the functional interface, while JSON::XS/2 is the OO
-    pretty-printing and hashkey sorting enabled).
+    interface with pretty-printing and hashkey sorting enabled). Higher is
+    better:
        module     |     encode |     decode |
        -----------|------------|------------|
        JSON       |      14006 |       6820 |
        JSON::DWIW |     200937 |     120386 |
        -----------+------------+------------+
     That is, JSON::XS is 6 times faster than than JSON::DWIW and about 80
     times faster than JSON, even with pretty-printing and key sorting.
-    Using a longer test string (roughly 8KB, generated from Yahoo! Locals
+    Using a longer test string (roughly 18KB, generated from Yahoo! Locals
     search API (http://nanoref.com/yahooapis/mgPdGg):
        module     |     encode |     decode |
        -----------|------------|------------|
        JSON       |        673 |         38 |
        -----------+------------+------------+
     Again, JSON::XS leads by far in the encoding case, while still beating
     every other module in the decoding case.
+    On large strings containing lots of unicode characters, some modules
+    (such as JSON::PC) decode faster than JSON::XS, but the result will be
+    broken due to missing unicode handling. Others refuse to decode or
+    encode properly, so it was impossible to prepare a fair comparison table
+    for that case.
 RESOURCE LIMITS
     JSON::XS does not impose any limits on the size of JSON texts or Perl
     values they represent - if your machine can handle it, JSON::XS will
     encode or decode it. Future versions might optionally impose structure
     depth and memory use resource limits.

Diff Legend

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

Comparing JSON-XS/README (file contents): Revision 1.4 by root, Fri Mar 23 18:33:50 2007 UTC vs. Revision 1.6 by root, Sat Mar 24 19:42:14 2007 UTC

Diff Legend

Comparing JSON-XS/README (file contents):
Revision 1.4 by root, Fri Mar 23 18:33:50 2007 UTC vs.
Revision 1.6 by root, Sat Mar 24 19:42:14 2007 UTC