.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "List::Objects::WithUtils::Role::Array::Typed 3pm"
.TH List::Objects::WithUtils::Role::Array::Typed 3pm 2024-03-07 "perl v5.38.2" "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
List::Objects::WithUtils::Role::Array::Typed \- Type\-checking array behavior
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&  # Via List::Objects::WithUtils::Array::Typed \->
\&  use List::Objects::WithUtils \*(Aqarray_of\*(Aq;
\&  use Types::Standard \-all;
\&  use List::Objects::Types \-all;
\&
\&  # Array of Ints:
\&  my $arr = array_of Int() => (1,2,3);
\&
\&  # Array of array objects of Ints (coerced from ARRAYs):
\&  my $arr = array_of TypedArray[Int] => [1,2,3], [4,5,6];
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This role makes use of Type::Tie to add type-checking behavior to
List::Objects::WithUtils::Role::Array consumers.
.PP
The first argument passed to the constructor should be a Type::Tiny type
(or other object conforming to Type::API, as of \f(CW\*(C`v2.25\*(C'\fR):
.PP
.Vb 2
\&  use Types::Standard \-all;
\&  my $arr = array_of Str() => qw/foo bar baz/;
.Ve
.PP
Elements are checked against the specified type when the object is constructed
or new elements are added.
.PP
If the initial type-check fails, a coercion is attempted.
.PP
Values that cannot be coerced will throw an exception.
.PP
Also see Types::Standard, List::Objects::Types
.SS type
.IX Subsection "type"
Returns the Type::Tiny type the object was created with.
.SS untyped
.IX Subsection "untyped"
Returns a (shallow) clone that is a plain List::Objects::WithUtils::Array.
.PP
Since most methods that return a new list will (attempt to) return a list
object of the same type as their parent, this can be useful to avoid type
check failures in a method chain that creates intermediate lists.
.SH AUTHOR
.IX Header "AUTHOR"
Jon Portnoy <avenj@cobaltirc.org> with significant contributions from Toby
Inkster (CPAN: TOBYINK)