.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "CGI::Struct::XS 3pm"
.TH CGI::Struct::XS 3pm "2020-11-09" "perl v5.32.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"
CGI::Struct::XS \- Build structures from CGI data. Fast.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is \s-1XS\s0 implementation of CGI::Struct.
It's fully compatible with CGI::Struct, except for error messages.
\&\f(CW\*(C`CGI::Struct::XS\*(C'\fR is 3\-15 (5\-25 with dclone disabled) times faster than original module.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  use CGI;
\&  use CGI::Struct::XS;
\&  my $cgi = CGI\->new;
\&  my %params = $cgi\->Vars;
\&  my $struct = build_cgi_struct \e%params;
\&  ...
.Ve
.PP
Or
.PP
.Vb 2
\&  use Plack::Request;
\&  use CGI::Struct::XS;
\&
\&  my $app_or_middleware = sub {
\&      my $env = shift; # PSGI env
\&      my $req = Plack::Request\->new($env);
\&      my $errs = [];
\&      my $struct = build_cgi_struct $req\->parameters, $errs, { dclone => 0 };
\&      ...
\&  }
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "build_cgi_struct"
.IX Subsection "build_cgi_struct"
.Vb 1
\&  $struct = build_cgi_struct \e%params;
\&  
\&  $struct = build_cgi_struct \e%params, \e@errs;
\&   
\&  $struct = build_cgi_struct \e%params, \e@errs, \e%conf;
.Ve
.PP
The only exported function is \f(CW\*(C`build_cgi_struct\*(C'\fR.
It has three arguments:
.ie n .IP """\e%params""" 4
.el .IP "\f(CW\e%params\fR" 4
.IX Item "%params"
HashRef with input values. Typicaly this is \s-1CGI\s0 or Plack params hashref
.ie n .IP """\e@errs""" 4
.el .IP "\f(CW\e@errs\fR" 4
.IX Item "@errs"
ArrayRef to store error messages. 
If it's not defined all parsing errors will be sielently discarded.
.ie n .IP """\e%conf""" 4
.el .IP "\f(CW\e%conf\fR" 4
.IX Item "%conf"
HashRef with parsing optiosn
.PP
Following options are supported:
.ie n .IP """nodot""" 4
.el .IP "\f(CWnodot\fR" 4
.IX Item "nodot"
Treat dot as ordinary character, not hash delimeter
.ie n .IP """nullsplit""" 4
.el .IP "\f(CWnullsplit\fR" 4
.IX Item "nullsplit"
Split input values by \f(CW\*(C`\e\e0\*(C'\fR character, useful for old \s-1CGI\s0 libraries
.ie n .IP """dclone""" 4
.el .IP "\f(CWdclone\fR" 4
.IX Item "dclone"
Store deep clone of value, instead of original value. 
This opion increase memory consumsion and slows parsing.
It's recomended to disable dclone, because in most cases \s-1CGI\s0 params are used as read-only variables.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CGI::Struct