.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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 "MooseX::Storage::Util 3pm" .TH MooseX::Storage::Util 3pm "2020-04-20" "perl v5.30.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" MooseX::Storage::Util \- A MooseX::Storage Swiss Army chainsaw .SH "VERSION" .IX Header "VERSION" version 0.53 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a set of tools, some sharp and focused, others more blunt and crude. But no matter what, they are useful bits to have around when dealing with MooseX::Storage code. .SH "METHODS" .IX Header "METHODS" All the methods in this package are class methods and should be called appropriately. .IP "\fBpeek ($data, \f(CB%options\fB)\fR" 4 .IX Item "peek ($data, %options)" This method will help you to verify that the serialized class you have gotten is what you expect it to be before you actually unfreeze/unpack it. .Sp The \f(CW$data\fR can be either a perl \s-1HASH\s0 ref or some kind of serialized data (\s-1JSON, YAML,\s0 etc.). .Sp The \f(CW%options\fR are as follows: .RS 4 .IP "\fIformat\fR" 4 .IX Item "format" If this is left blank, we assume that \f(CW$data\fR is a plain perl \s-1HASH\s0 ref otherwise we attempt to inflate \f(CW$data\fR based on the value of this option. .Sp Currently only \s-1JSON\s0 and \s-1YAML\s0 are supported here. .IP "\fIkey\fR" 4 .IX Item "key" The default is to try and extract the class name, but if you want to check another key in the data, you can set this option. It will return the value found in the key for you. .RE .RS 4 .RE .SH "TODO" .IX Header "TODO" Add more stuff to this module :) .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-MooseX\-Storage@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#moose\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Chris Prather .IP "\(bu" 4 Stevan Little .IP "\(bu" 4 יובל קוג'מן (Yuval Kogman) .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2007 by Infinity Interactive, Inc. .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.