.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 "JSON::MaybeXS 3pm"
.TH JSON::MaybeXS 3pm "2014-10-22" "perl v5.20.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"
JSON::MaybeXS \- Use Cpanel::JSON::XS with a fallback to JSON::XS and JSON::PP
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use JSON::MaybeXS;
\&
\&  my $data_structure = decode_json($json_input);
\&
\&  my $json_output = encode_json($data_structure);
\&
\&  my $json = JSON\->new;
\&
\&  my $json_with_args = JSON::MaybeXS\->new(utf8 => 1); # or { utf8 => 1 }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module first checks to see if either Cpanel::JSON::XS or
\&\s-1JSON::XS\s0 is already loaded, in which case it uses that module. Otherwise
it tries to load Cpanel::JSON::XS, then \s-1JSON::XS\s0, then \s-1JSON::PP\s0
in order, and either uses the first module it finds or throws an error.
.PP
It then exports the \f(CW\*(C`encode_json\*(C'\fR and \f(CW\*(C`decode_json\*(C'\fR functions from the
loaded module, along with a \f(CW\*(C`JSON\*(C'\fR constant that returns the class name
for calling \f(CW\*(C`new\*(C'\fR on.
.PP
If you're writing fresh code rather than replacing \s-1JSON\s0.pm usage, you might
want to pass options as constructor args rather than calling mutators, so
we provide our own \f(CW\*(C`new\*(C'\fR method that supports that.
.SH "EXPORTS"
.IX Header "EXPORTS"
\&\f(CW\*(C`encode_json\*(C'\fR, \f(CW\*(C`decode_json\*(C'\fR and \f(CW\*(C`JSON\*(C'\fR are exported by default; \f(CW\*(C`is_bool\*(C'\fR
is exported on request.
.PP
To import only some symbols, specify them on the \f(CW\*(C`use\*(C'\fR line:
.PP
.Vb 1
\&  use JSON::MaybeXS qw(encode_json decode_json is_bool); # functions only
\&
\&  use JSON::MaybeXS qw(JSON); # JSON constant only
.Ve
.PP
To import all available symbols, use \f(CW\*(C`:all\*(C'\fR:
.PP
.Vb 1
\&  use JSON::MaybeXS \*(Aq:all\*(Aq;
.Ve
.SS "encode_json"
.IX Subsection "encode_json"
This is the \f(CW\*(C`encode_json\*(C'\fR function provided by the selected implementation
module, and takes a perl data structure which is serialised to \s-1JSON\s0 text.
.PP
.Vb 1
\&  my $json_text = encode_json($data_structure);
.Ve
.SS "decode_json"
.IX Subsection "decode_json"
This is the \f(CW\*(C`decode_json\*(C'\fR function provided by the selected implementation
module, and takes a string of \s-1JSON\s0 text to deserialise to a perl data structure.
.PP
.Vb 1
\&  my $data_structure = decode_json($json_text);
.Ve
.SS "\s-1JSON\s0"
.IX Subsection "JSON"
The \f(CW\*(C`JSON\*(C'\fR constant returns the selected implementation module's name for
use as a class name \- so:
.PP
.Vb 1
\&  my $json_obj = JSON\->new; # returns a Cpanel::JSON::XS or JSON::PP object
.Ve
.PP
and that object can then be used normally:
.PP
.Vb 1
\&  my $data_structure = $json_obj\->decode($json_text); # etc.
.Ve
.SS "is_bool"
.IX Subsection "is_bool"
.Vb 1
\&  $is_boolean = is_bool($scalar)
.Ve
.PP
Returns true if the passed scalar represents either \f(CW\*(C`true\*(C'\fR or
\&\f(CW\*(C`false\*(C'\fR, two constants that act like \f(CW1\fR and \f(CW0\fR, respectively
and are used to represent \s-1JSON \s0\f(CW\*(C`true\*(C'\fR and \f(CW\*(C`false\*(C'\fR values in Perl.
.PP
Since this is a bare sub in the various backend classes, it cannot be called as
a class method like the other interfaces; it must be called as a function, with
no invocant.  It supports the representation used in all \s-1JSON\s0 backends.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
With \s-1JSON::PP\s0, \s-1JSON::XS\s0 and Cpanel::JSON::XS you are required to call
mutators to set options, such as:
.PP
.Vb 1
\&  my $json = $class\->new\->utf8(1)\->pretty(1);
.Ve
.PP
Since this is a trifle irritating and noticeably un-perlish, we also offer:
.PP
.Vb 1
\&  my $json = JSON::MaybeXS\->new(utf8 => 1, pretty => 1);
.Ve
.PP
which works equivalently to the above (and in the usual tradition will accept
a hashref instead of a hash, should you so desire).
.SH "BOOLEANS"
.IX Header "BOOLEANS"
To include JSON-aware booleans (\f(CW\*(C`true\*(C'\fR, \f(CW\*(C`false\*(C'\fR) in your data, just do:
.PP
.Vb 3
\&    use JSON::MaybeXS;
\&    my $true = JSON\->true;
\&    my $false = JSON\->false;
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
mst \- Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
.IP "\(bu" 4
Clinton Gormley <drtech@cpan.org>
.IP "\(bu" 4
Karen Etheridge <ether@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2013 the \f(CW\*(C`JSON::MaybeXS\*(C'\fR \*(L"\s-1AUTHOR\*(R"\s0 and \*(L"\s-1CONTRIBUTORS\*(R"\s0
as listed above.
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software and may be distributed under the same terms
as perl itself.