/ 
YAML-Syck-0.72
River stage three • 185 direct dependents • 726 total dependents
/ JSON::Syck

NAME

JSON::Syck - JSON is YAML

SYNOPSIS

use JSON::Syck;

my $data = JSON::Syck::Load($json);
my $json = JSON::Syck::Dump($data);

DESCRIPTION

JSON::Syck is a syck implementatoin of JSON parsing and generation. Because JSON is YAML (http://redhanded.hobix.com/inspect/yamlIsJson.html), using syck gives you the fastest and most memory efficient parser and dumper for JSON data representation.

DIFFERENCE WITH JSON

You might want to know the difference between JSON and JSON::Syck.

Since JSON is a pure-perl module and JSON::Syck is based on libsyck, JSON::Syck is supposed to be very fast and memory efficient. See chansen's benchmark table at http://idisk.mac.com/christian.hansen/Public/perl/serialize.pl

JSON.pm comes with dozens of ways to do the same thing and lots of options, while JSON::Syck doesn't. There's only Load and Dump.

Oh, and JSON::Syck doesn't use camelCase method names :-)

REFERENCES

SCALAR REFERNECE

For now, when you pass a scalar reference to JSON::Syck, it derefernces to get the actual scalar value. It means when you pass self-referencing reference, JSON::Syck goes into infinite loop. Don't do it.

If you want to serialize self refernecing stuff, you should use YAML which supports it.

SUBROUTINE REFERENCE

When you pass subroutine reference, JSON::Syck dumps it as null.

UTF-8 FLAGS

By default this module doesn't touch any of utf-8 flags set in strings, and assumes UTF-8 bytes to be passed and emit.

However, when you set $JSON::Syck::ImplicitUnicode to 1, this module properly decodes UTF-8 binaries and sets UTF-8 flag everywhere, as in:

JSON (UTF-8 bytes)   => Perl (UTF-8 flagged)
JSON (UTF-8 flagged) => Perl (UTF-8 flagged)
Perl (UTF-8 bytes)   => JSON (UTF-8 flagged)
Perl (UTF-8 flagged) => JSON (UTF-8 flagged)

Unfortunately, there's no implicit way to dump Perl UTF-8 flagged data structure to utf-8 encoded JSON. To do this, simply use Encode module, e.g.:

use Encode;
use JSON::Syck qw(Dump);

my $json = encode_utf8( Dump($data) );

Alternatively you can use Encode::JavaScript::UCS to encode Unicode strings as in %uXXXX form.

use Encode;
use Encode::JavaScript::UCS;
use JSON::Syck qw(Dump);

my $json_unicode_escaped = encode( 'JavaScript-UCS', Dump($data) );

QUOTING

According to the JSON specification, all JSON strings are to be double-quoted. However, when embedding JavaScript in HTML attributes, it may be more convenient to use single quotes.

Set $JSON::Syck::SingleQuote to 1 will make both Dump and Load expect single-quoted string literals.

AUTHORS

Audrey Tang <cpan@audreyt.org>

Tatsuhiko Miyagawa <miyagawa@gmail.com>

This module is originally forked from Audrey Tang's excellent YAML::Syck module and 99.9% of the XS code is written by Audrey.

The libsyck code bundled with this module is written by why the lucky stiff, under a BSD-style license. See the COPYING file for details.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.