.\" 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 "Specio::Constraint::Structured 3pm"
.TH Specio::Constraint::Structured 3pm "2022-06-21" "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"
Specio::Constraint::Structured \- A class which represents structured constraints
.SH "VERSION"
.IX Header "VERSION"
version 0.48
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    my $tuple = t(\*(AqTuple\*(Aq);
\&
\&    my $tuple_of_str_int = $tuple\->parameterize( of => [ t(\*(AqStr\*(Aq), t(\*(AqInt\*(Aq) ] );
\&
\&    my $parent = $tuple_of_str_int\->parent; # returns Tuple
\&    my $parameters = $arrayref_of_int\->parameters; # returns { of => [ t(\*(AqStr\*(Aq), t(\*(AqInt\*(Aq) ] }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class implements the \s-1API\s0 for structured types.
.SH "API"
.IX Header "API"
This class implements the same \s-1API\s0 as Specio::Constraint::Simple, with a few
additions.
.SS "Specio::Constraint::Structured\->new(...)"
.IX Subsection "Specio::Constraint::Structured->new(...)"
This class's constructor accepts two additional parameters:
.IP "\(bu" 4
parent
.Sp
This should be the Specio::Constraint::Structurable object from which this
object was created.
.Sp
This parameter is required.
.IP "\(bu" 4
parameters
.Sp
This is the hashref of parameters for the structured type. These are the
parameters returned by the \f(CW\*(C`Structurable\*(C'\fR type's
\&\f(CW\*(C`parameterization_args_builder\*(C'\fR. The exact form of this hashref will vary for
each structured type.
.Sp
This parameter is required.
.ie n .SS "$type\->parameters"
.el .SS "\f(CW$type\fP\->parameters"
.IX Subsection "$type->parameters"
Returns the hashref that was passed to the constructor.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted at <https://github.com/houseabsolute/Specio/issues>.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Specio can be found at <https://github.com/houseabsolute/Specio>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2012 \- 2022 by Dave Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve
.PP
The full text of the license can be found in the
\&\fI\s-1LICENSE\s0\fR file included with this distribution.