.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TOML 3pm" .TH TOML 3pm "2016-03-21" "perl v5.22.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" TOML \- Parser for Tom's Obvious, Minimal Language. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use TOML qw(from_toml to_toml); \& \& # Parsing toml \& my $toml = slurp("~/.foo.toml"); \& my $data = from_toml($toml); \& \& # With error checking \& my ($data, $err) = from_toml($toml); \& unless ($data) { \& die "Error parsing toml: $err"; \& } \& \& # Creating toml \& my $toml = to_toml($data); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`TOML\*(C'\fR implements a parser for Tom's Obvious, Minimal Language, as defined at . \f(CW\*(C`TOML\*(C'\fR exports two subroutines, \f(CW\*(C`from_toml\*(C'\fR and \f(CW\*(C`to_toml\*(C'\fR, .SH "FAQ" .IX Header "FAQ" .IP "How change how to de-serialize?" 4 .IX Item "How change how to de-serialize?" You can change \f(CW$TOML::PARSER\fR for change how to de-serialize. .Sp example: .Sp .Vb 2 \& use TOML; \& use TOML::Parser; \& \& local $TOML::PARSER = TOML::Parser\->new( \& inflate_boolean => sub { $_[0] eq \*(Aqtrue\*(Aq ? \e1 : \e0 }, \& ); \& \& my $data = TOML::from_toml(\*(Aqfoo = true\*(Aq); .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .IP "from_toml" 4 .IX Item "from_toml" \&\f(CW\*(C`from_toml\*(C'\fR transforms a string containing toml to a perl data structure or vice versa. This data structure complies with the tests provided at . .Sp If called in list context, \f(CW\*(C`from_toml\*(C'\fR produces a (\f(CW\*(C`hash\*(C'\fR, \&\f(CW\*(C`error_string\*(C'\fR) tuple, where \f(CW\*(C`error_string\*(C'\fR is \f(CW\*(C`undef\*(C'\fR on non-errors. If there is an error, then \f(CW\*(C`hash\*(C'\fR will be undefined and \&\f(CW\*(C`error_string\*(C'\fR will contains (scant) details about said error. .IP "to_toml" 4 .IX Item "to_toml" \&\f(CW\*(C`to_toml\*(C'\fR transforms a perl data structure into toml-formatted string. .SH "SEE ALSO" .IX Header "SEE ALSO" TOML::Parser .SH "LICENSE" .IX Header "LICENSE" This program is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; version 2. .PP This program is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, \s-1MA 02111\-1301 USA\s0 .SH "AUTHOR" .IX Header "AUTHOR" Darren Chamberlain .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "Tokuhiro Matsuno " 4 .IX Item "Tokuhiro Matsuno " .PD 0 .IP "Matthias Bethke " 4 .IX Item "Matthias Bethke " .IP "Sergey Romanov " 4 .IX Item "Sergey Romanov " .IP "karupanerura " 4 .IX Item "karupanerura "