=pod =head1 NAME YAML::Syck - Fast, lightweight YAML loader and dumper =head1 VERSION This document describes version 0.82 of YAML::Syck, released January 26, 2007. =head1 SYNOPSIS use YAML::Syck; # Set this for interoperability with other YAML/Syck bindings: # e.g. Load('Yes') becomes 1 and Load('No') becomes undef. $YAML::Syck::ImplicitTyping = 1; $data = Load($yaml); $data = LoadFile($file); $yaml = Dump($data); DumpFile($file, $data); # A string with multiple YAML streams in it $yaml = Dump(@data); @data = Load($yaml); =head1 DESCRIPTION This module provides a Perl interface to the B data serialization library. It exports the C and C functions for converting Perl data structures to YAML strings, and the other way around. B: If you are working with other language's YAML/Syck bindings (such as Ruby), please set C<$YAML::Syck::ImplicitTyping> to C<1> before calling the C/C functions. The default setting is for preserving backward-compatibility with C. =head1 FLAGS =head2 $YAML::Syck::Headless Defaults to false. Setting this to a true value will make C omit the leading C<---\n> marker. =head2 $YAML::Syck::SortKeys Defaults to false. Setting this to a true value will make C sort hash keys. =head2 $YAML::Syck::ImplicitTyping Defaults to false. Setting this to a true value will make C recognize various implicit types in YAML, such as unquoted C, C, as well as integers and floating-point numbers. Otherwise, only C<~> is recognized to be C. =head2 $YAML::Syck::ImplicitUnicode Defaults to false. For Perl 5.8.0 or later, setting this to a true value will make C set Unicode flag on for every string that contains valid UTF8 sequences, and make C return a unicode string. Regardless of this flag, Unicode strings are dumped verbatim without escaping; byte strings with high-bit set will be dumped with backslash escaping. However, because YAML does not distinguish between these two kinds of strings, so this flag will affect loading of both variants of strings. =head2 $YAML::Syck::ImplicitBinary Defaults to false. For Perl 5.8.0 or later, setting this to a true value will make C generate Base64-encoded C data for all non-Unicode scalars containing high-bit bytes. =head2 $YAML::Syck::UseCode =head2 $YAML::Syck::LoadCode =head2 $YAML::Syck::DumpCode These control whether or not to try and eval/deparse perl source code. =head1 CAVEATS The current implementation bundles libsyck source code; if your system has a side-wide shared libsyck, it will I be used. Tag names such as C is blessed into the package C, but the C and C tags are blessed into C. Note that this holds true even if the tag contains non-word characters; for example, C is blessed into C. Please use L to cast it into other user-defined packages. =head1 SEE ALSO L, L L =head1 AUTHORS Audrey Tang Ecpan@audreyt.orgE =head1 COPYRIGHT Copyright 2005, 2006, 2007 by Audrey Tang Ecpan@audreyt.orgE. This software is released under the MIT license cited below. The F code bundled with this library is released by "why the lucky stiff", under a BSD-style license. See the F file for details. =head2 The "MIT" License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. =cut