The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

DROLSKY / Specio-0.50 / lib / Specio / Constraint / Structured.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
—
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

              
package Specio::Constraint::Structured;
use strict;
use warnings;
our $VERSION = '0.50';
use Clone ();
use List::Util 1.33 qw( all );
use Role::Tiny::With;
use Specio::OO;
use Specio::TypeChecks qw( does_role );
use Specio::Constraint::Role::Interface;
with 'Specio::Constraint::Role::Interface';
{
    ## no critic (Subroutines::ProtectPrivateSubs)
    my $attrs = Clone::clone( Specio::Constraint::Role::Interface::_attrs() );
    ## use critic
    $attrs->{parent}{isa}      = 'Specio::Constraint::Structurable';
    $attrs->{parent}{required} = 1;
    $attrs->{parameters} = {
        isa      => 'HashRef',
        required => 1,
    };
    ## no critic (Subroutines::ProhibitUnusedPrivateSubroutines)
    sub _attrs {
        return $attrs;
    }
}
sub can_be_inlined {
    my $self = shift;
    return $self->_has_inline_generator;
}
__PACKAGE__->_ooify;
1;
# ABSTRACT: A class which represents structured constraints
__END__
=pod
=encoding UTF-8
=head1 NAME
Specio::Constraint::Structured - A class which represents structured constraints
=head1 VERSION
version 0.50
=head1 SYNOPSIS
    my $tuple = t('Tuple');
    my $tuple_of_str_int = $tuple->parameterize( of => [ t('Str'), t('Int') ] );
    my $parent = $tuple_of_str_int->parent; # returns Tuple
    my $parameters = $arrayref_of_int->parameters; # returns { of => [ t('Str'), t('Int') ] }
=head1 DESCRIPTION
This class implements the API for structured types.
=for Pod::Coverage can_be_inlined type_parameter
=head1 API
This class implements the same API as L<Specio::Constraint::Simple>, with a few
additions.
=head2 Specio::Constraint::Structured->new(...)
This class's constructor accepts two additional parameters:
=over 4
=item * parent
This should be the L<Specio::Constraint::Structurable> object from which this
object was created.
This parameter is required.
=item * parameters
This is the hashref of parameters for the structured type. These are the
parameters returned by the C<Structurable> type's
C<parameterization_args_builder>. The exact form of this hashref will vary for
each structured type.
This parameter is required.
=back
=head2 $type->parameters
Returns the hashref that was passed to the constructor.
=head1 SUPPORT
Bugs may be submitted at L<https://github.com/houseabsolute/Specio/issues>.
=head1 SOURCE
The source code repository for Specio can be found at L<https://github.com/houseabsolute/Specio>.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 - 2025 by Dave Rolsky.
This is free software, licensed under:
  The Artistic License 2.0 (GPL Compatible)
The full text of the license can be found in the
F<LICENSE> file included with this distribution.
=cut