.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (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
.\" ========================================================================
.\"
.IX Title "Sub::HandlesVia::HandlerLibrary::Enum 3"
.TH Sub::HandlesVia::HandlerLibrary::Enum 3 2024-09-02 "perl v5.40.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
Sub::HandlesVia::HandlerLibrary::Enum \- library of enum\-related methods
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\&  package My::Class {
\&    use Moo;
\&    use Sub::HandlesVia;
\&    use Types::Standard \*(AqEnum\*(Aq;
\&    has status => (
\&      is => \*(Aqro\*(Aq,
\&      isa => Enum[ \*(Aqpass\*(Aq, \*(Aqfail\*(Aq ],
\&      handles_via => \*(AqEnum\*(Aq,
\&      handles => {
\&        \*(Aqis_pass\*(Aq      => [ is     => \*(Aqpass\*(Aq ],
\&        \*(Aqis_fail\*(Aq      => [ is     => \*(Aqfail\*(Aq ],
\&        \*(Aqassign_pass\*(Aq  => [ assign => \*(Aqpass\*(Aq ],
\&        \*(Aqassign_fail\*(Aq  => [ assign => \*(Aqfail\*(Aq ],
\&      },
\&      default => sub { \*(Aqfail\*(Aq },
\&    );
\&  }
.Ve
.PP
Or, using a shortcut:
.PP
.Vb 10
\&  package My::Class {
\&    use Moo;
\&    use Sub::HandlesVia;
\&    use Types::Standard \*(AqEnum\*(Aq;
\&    has status => (
\&      is => \*(Aqro\*(Aq,
\&      isa => Enum[ \*(Aqpass\*(Aq, \*(Aqfail\*(Aq ],
\&      handles_via => \*(AqEnum\*(Aq,
\&      handles => {
\&        \*(Aqis_pass\*(Aq      => \*(Aqis_pass\*(Aq,
\&        \*(Aqis_fail\*(Aq      => \*(Aqis_fail\*(Aq,
\&        \*(Aqassign_pass\*(Aq  => \*(Aqassign_pass\*(Aq,
\&        \*(Aqassign_fail\*(Aq  => \*(Aqassign_fail\*(Aq,
\&      },
\&      default => sub { \*(Aqfail\*(Aq },
\&    );
\&  }
.Ve
.PP
(Sub::HandlesVia::HandlerLibrary::Enum will split on "_".)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a library of methods for Sub::HandlesVia.
.SH "DELEGATABLE METHODS"
.IX Header "DELEGATABLE METHODS"
This allows for delegation roughly compatible with MooseX::Enumeration
and MooX::Enumeration, even though that's basically a renamed subset of
Sub::HandlesVia::HandlerLibrary::String anyway.
.ie n .SS "is( $value )"
.el .SS "\f(CWis( $value )\fP"
.IX Subsection "is( $value )"
Returns a boolean indicating whether the enum is that value.
.PP
.Vb 3
\&  my $object = My::Class\->new( status => \*(Aqpass\*(Aq );
\&  say $object\->is_pass(); ## ==> true
\&  say $object\->is_fail(); ## ==> false
.Ve
.ie n .SS "assign( $value )"
.el .SS "\f(CWassign( $value )\fP"
.IX Subsection "assign( $value )"
Sets the enum to the value.
.PP
.Vb 6
\&  my $object = My::Class\->new( status => \*(Aqpass\*(Aq );
\&  say $object\->is_pass(); ## ==> true
\&  say $object\->is_fail(); ## ==> false
\&  $object\->assign_fail();
\&  say $object\->is_pass(); ## ==> false
\&  say $object\->is_fail(); ## ==> true
.Ve
.ie n .SS "set( $value )"
.el .SS "\f(CWset( $value )\fP"
.IX Subsection "set( $value )"
An alias for \f(CW\*(C`assign\*(C'\fR.
.SH "TYPE CONSTRAINT SHORTCUT"
.IX Header "TYPE CONSTRAINT SHORTCUT"
The Enum handler library also allows an \f(CW\*(C`enum\*(C'\fR shortcut in the attribute
spec.
.PP
.Vb 10
\&  package My::Class {
\&    use Moo;
\&    use Sub::HandlesVia;
\&    has status => (
\&      is          => \*(Aqro\*(Aq,
\&      enum        => [ \*(Aqpass\*(Aq, \*(Aqfail\*(Aq ],
\&      handles_via => \*(AqEnum\*(Aq,
\&      handles     => {
\&        \*(Aqis_pass\*(Aq      => [ is     => \*(Aqpass\*(Aq ],
\&        \*(Aqis_fail\*(Aq      => [ is     => \*(Aqfail\*(Aq ],
\&        \*(Aqassign_pass\*(Aq  => [ assign => \*(Aqpass\*(Aq ],
\&        \*(Aqassign_fail\*(Aq  => [ assign => \*(Aqfail\*(Aq ],
\&      },
\&      default     => sub { \*(Aqfail\*(Aq },
\&    );
\&  }
.Ve
.SH "SHORTCUT CONSTANTS"
.IX Header "SHORTCUT CONSTANTS"
This module provides some shortcut constants for indicating a list of
delegations.
.PP
.Vb 10
\&  package My::Class {
\&    use Moo;
\&    use Types::Standard qw( Enum );
\&    use Sub::HandlesVia;
\&    use Sub::HandlesVia::HandlerLibrary::Enum qw( HandleIs );
\&    has status => (
\&      is          => \*(Aqro\*(Aq,
\&      isa         => Enum[ \*(Aqpass\*(Aq, \*(Aqfail\*(Aq ],
\&      handles_via => \*(AqEnum\*(Aq,
\&      handles     => HandleIs,
\&      default     => sub { \*(Aqfail\*(Aq },
\&    );
\&  }
.Ve
.PP
Any of these shortcuts can be combined using the \f(CW\*(C` | \*(C'\fR operator.
.PP
.Vb 7
\&    has status => (
\&      is          => \*(Aqro\*(Aq,
\&      isa         => Enum[ \*(Aqpass\*(Aq, \*(Aqfail\*(Aq ],
\&      handles_via => \*(AqEnum\*(Aq,
\&      handles     => HandleIs | HandleSet,
\&      default     => sub { \*(Aqfail\*(Aq },
\&    );
.Ve
.ie n .SS """HandleIs"""
.el .SS \f(CWHandleIs\fP
.IX Subsection "HandleIs"
Creates delegations named like \f(CW\*(C`is_pass\*(C'\fR and \f(CW\*(C`is_fail\*(C'\fR.
.ie n .SS """HandleNamedIs"""
.el .SS \f(CWHandleNamedIs\fP
.IX Subsection "HandleNamedIs"
Creates delegations named like \f(CW\*(C`status_is_pass\*(C'\fR and \f(CW\*(C`status_is_fail\*(C'\fR.
.ie n .SS """HandleSet"""
.el .SS \f(CWHandleSet\fP
.IX Subsection "HandleSet"
Creates delegations named like \f(CW\*(C`set_pass\*(C'\fR and \f(CW\*(C`set_fail\*(C'\fR.
.ie n .SS """HandleNamedSet"""
.el .SS \f(CWHandleNamedSet\fP
.IX Subsection "HandleNamedSet"
Creates delegations named like \f(CW\*(C`status_set_pass\*(C'\fR and \f(CW\*(C`status_set_fail\*(C'\fR.
.SH BUGS
.IX Header "BUGS"
Please report any bugs to
<https://github.com/tobyink/p5\-sub\-handlesvia/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sub::HandlesVia.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2022 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.