.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 >0, 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 .\" ======================================================================== .\" .IX Title "KiokuDB::Backend::Serialize::JSON 3pm" .TH KiokuDB::Backend::Serialize::JSON 3pm "2022-05-23" "perl v5.34.0" "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" KiokuDB::Backend::Serialize::JSON \- Role to serialize entries to JSON strings with KiokuDB::Backend::Serialize::JSPON semantics .SH "VERSION" .IX Header "VERSION" version 0.57 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& with qw(KiokuDB::Backend::Serialize::JSON); \& \& sub foo { \& my ( $self, $entry ) = @_; \& \& my $json_string = $self\->serialize($entry); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This role provides additional convenience attributes and methods for backends that encode entries to \s-1JSON\s0 strings, on top of KiokuDB::Backend::Serialize::JSPON which only restructures the data. .PP KiokuDB::Backend::Serialize::Delegate is preferred to using this directly. .SH "METHODS" .IX Header "METHODS" .ie n .IP "serialize $entry" 4 .el .IP "serialize \f(CW$entry\fR" 4 .IX Item "serialize $entry" Returns a \s-1JSON\s0 string .ie n .IP "deserialize $json_str" 4 .el .IP "deserialize \f(CW$json_str\fR" 4 .IX Item "deserialize $json_str" Returns a KiokuDB::Entry .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .IP "json" 4 .IX Item "json" The \s-1JSON\s0 instance used to encode/decode the \s-1JSON.\s0 .IP "pretty" 4 .IX Item "pretty" Whether or not to pass the \f(CW\*(C`pretty\*(C'\fR flag to the \s-1JSON\s0 object after construction. .SH "AUTHOR" .IX Header "AUTHOR" Yuval Kogman .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2014 by Yuval Kogman, Infinity Interactive. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.