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

Comparing JSON-XS/README (file contents):
Revision 1.24 by root, Thu Mar 27 06:37:35 2008 UTC vs.
Revision 1.25 by root, Wed Apr 16 18:38:38 2008 UTC

         Example, encode a Perl scalar as JSON value with enabled
         "allow_nonref", resulting in an invalid JSON text:
            JSON::XS->new->allow_nonref->encode ("Hello, World!")
            => "Hello, World!"
+    $json = $json->allow_unknown ([$enable])
+    $enabled = $json->get_allow_unknown
+        If $enable is true (or missing), then "encode" will *not* throw an
+        exception when it encounters values it cannot represent in JSON (for
+        example, filehandles) but instead will encode a JSON "null" value.
+        Note that blessed objects are not included here and are handled
+        separately by c<allow_nonref>.
+        If $enable is false (the default), then "encode" will throw an
+        exception when it encounters anything it cannot encode as JSON.
+        This option does not affect "decode" in any way, and it is
+        recommended to leave it off unless you know your communications
+        partner.
     $json = $json->allow_blessed ([$enable])
     $enabled = $json->get_allow_blessed
         If $enable is true (or missing), then the "encode" method will not
         barf when it encounters a blessed reference. Instead, the value of
         saving space.
     $json = $json->max_depth ([$maximum_nesting_depth])
     $max_depth = $json->get_max_depth
         Sets the maximum nesting level (default 512) accepted while encoding
-        or decoding. If the JSON text or Perl data structure has an equal or
+        or decoding. If a higher nesting level is detected in JSON text or a
-        higher nesting level then this limit, then the encoder and decoder
+        Perl data structure, then the encoder and decoder will stop and
-        will stop and croak at that point.
+        croak at that point.
         Nesting level is defined by number of hash- or arrayrefs that the
         encoder needs to traverse to reach a given point or the number of
         "{" or "[" characters without their matching closing parenthesis
         crossed to reach a given character in a string.
         Setting the maximum depth to one disallows any nesting, so that
         ensures that the object is only a single hash/object or array.
-        The argument to "max_depth" will be rounded up to the next highest
-        power of two. If no argument is given, the highest possible setting
+        If no argument is given, the highest possible setting will be used,
-        will be used, which is rarely useful.
+        which is rarely useful.
+        Note that nesting is implemented by recursion in C. The default
+        value has been chosen to be as large as typical operating systems
+        allow without crashing.
         See SECURITY CONSIDERATIONS, below, for more info on why this is
         useful.
     $json = $json->max_size ([$maximum_string_size])
     $max_size = $json->get_max_size
         Set the maximum length a JSON text may have (in bytes) where
         decoding is being attempted. The default is 0, meaning no limit.
-        When "decode" is called on a string longer then this number of
+        When "decode" is called on a string that is longer then this many
-        characters it will not attempt to decode the string but throw an
+        bytes, it will not attempt to decode the string but throw an
         exception. This setting has no effect on "encode" (yet).
-        The argument to "max_size" will be rounded up to the next highest
-        power of two (so may be more than requested). If no argument is
-        given, the limit check will be deactivated (same as when 0 is
+        If no argument is given, the limit check will be deactivated (same
-        specified).
+        as when 0 is specified).
         See SECURITY CONSIDERATIONS, below, for more info on why this is
         useful.
     $json_text = $json->encode ($perl_scalar)
     First comes a comparison between various modules using a very short
     single-line JSON string (also available at
     <http://dist.schmorp.de/misc/json/short.json>).
-       {"method": "handleMessage", "params": ["user1", "we were just talking"], \
+       {"method": "handleMessage", "params": ["user1",
-       "id": null, "array":[1,11,234,-5,1e5,1e7, true,  false]}
+       "we were just talking"], "id": null, "array":[1,11,234,-5,1e5,1e7,
+       true,  false]}
     It shows the number of encodes/decodes per second (JSON::XS uses the
     functional interface, while JSON::XS/2 uses the OO interface with
     pretty-printing and hashkey sorting enabled, JSON::XS/3 enables shrink).
     Higher is better:

Diff Legend

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

Comparing JSON-XS/README (file contents): Revision 1.24 by root, Thu Mar 27 06:37:35 2008 UTC vs. Revision 1.25 by root, Wed Apr 16 18:38:38 2008 UTC

Diff Legend

Comparing JSON-XS/README (file contents):
Revision 1.24 by root, Thu Mar 27 06:37:35 2008 UTC vs.
Revision 1.25 by root, Wed Apr 16 18:38:38 2008 UTC