.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Types::Standard::CycleTuple 3"
.TH Types::Standard::CycleTuple 3 2025-07-14 "perl v5.42.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
Types::Standard::CycleTuple \- exporter utility for the CycleTuple type constraint
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Types::Standard \-types;
\&  
\&  # Normal way to validate a list of pairs of integers.
\&  #
\&  CycleTuple\->of( Int, Int )\->assert_valid( [ 7, 49, 8, 64 ] );
\&  
\&  use Types::Standard::CycleTuple IntPairs => { of => [ Int, Int ] },
\&  
\&  # Exported shortcut
\&  #
\&  assert_IntPairs [ 7, 49, 8, 64 ];
.Ve
.SH STATUS
.IX Header "STATUS"
This module is not covered by the
Type\-Tiny stability policy.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is mostly internal code, but can also act as an exporter utility.
.SS Exports
.IX Subsection "Exports"
Types::Standard::CycleTuple can be used experimentally as an exporter.
.PP
.Vb 2
\&  use Types::Standard \*(AqInt\*(Aq;
\&  use Types::Standard::CycleTuple IntPairs => { of => [ Int, Int ] };
.Ve
.PP
This will export the following functions into your namespace:
.ie n .IP """IntPairs""" 4
.el .IP \f(CWIntPairs\fR 4
.IX Item "IntPairs"
.PD 0
.ie n .IP "is_IntPairs( $value )" 4
.el .IP "\f(CWis_IntPairs( $value )\fR" 4
.IX Item "is_IntPairs( $value )"
.ie n .IP "assert_IntPairs( $value )" 4
.el .IP "\f(CWassert_IntPairs( $value )\fR" 4
.IX Item "assert_IntPairs( $value )"
.ie n .IP "to_IntPairs( $value )" 4
.el .IP "\f(CWto_IntPairs( $value )\fR" 4
.IX Item "to_IntPairs( $value )"
.PD
.PP
Multiple types can be exported at once:
.PP
.Vb 5
\&  use Types::Standard \-types;
\&  use Types::Standard::CycleTuple (
\&    IntIntPairs   => { of => [ Int, Int ] },
\&    StrIntPairs   => { of => [ Str, Int ] },
\&  );
\&  
\&  assert_StrIntPairs [ one => 1, two => 2 ];   # should not die
.Ve
.PP
It\*(Aqs possible to further constrain the cycletuple using \f(CW\*(C`where\*(C'\fR:
.PP
.Vb 1
\&  use Types::Standard::CycleTuple MyThing => { of => [ ... ], where => sub { ... } };
.Ve
.SH BUGS
.IX Header "BUGS"
Please report any bugs to
<https://github.com/tobyink/p5\-type\-tiny/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Types::Standard.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2013\-2025 by Toby Inkster.
.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.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.