.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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 "Sub::HandlesVia::Manual::WithMouse 3pm"
.TH Sub::HandlesVia::Manual::WithMouse 3pm "2023-04-09" "perl v5.36.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::Manual::WithMouse \- using Sub::HandlesVia with Mouse
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\& package Kitchen {
\&   use Mouse;
\&   use Sub::HandlesVia;
\&   use Types::Standard qw( ArrayRef Str );
\&   
\&   has food => (
\&     is          => \*(Aqro\*(Aq,
\&     isa         => ArrayRef[Str],
\&     handles_via => \*(AqArray\*(Aq,
\&     default     => sub { [] },
\&     handles     => {
\&       \*(Aqadd_food\*(Aq    => \*(Aqpush\*(Aq,
\&       \*(Aqfind_food\*(Aq   => \*(Aqgrep\*(Aq,
\&     },
\&   );
\& }
.Ve
.PP
(If you have a mouse in your kitchen, that might not be very hygienic.)
.SH "MANUAL"
.IX Header "MANUAL"
Sub::HandlesVia allows you to delegate methods from your class to the
values of your objects' attributes.
.PP
Conceptually, it allows you to define \f(CW\*(C`$object\->push_number($n)\*(C'\fR
to be a shortcut for \f(CW\*(C`$object\->numbers\->push($n)\*(C'\fR except that
\&\f(CW\*(C`$object\->numbers\*(C'\fR is an arrayref, so doesn't have methods you
can call on it like \f(CW\*(C`push\*(C'\fR.
.PP
You should be able to use Sub::HandlesVia as a drop-in replacement for
MouseX::NativeTraits, just replacing \f(CW\*(C`traits => [\*(AqArray\*(Aq]\*(C'\fR in an
attribute definition with \f(CW\*(C`handles_via => \*(AqArray\*(Aq\*(C'\fR.
.SS "Usage in Mouse Roles"
.IX Subsection "Usage in Mouse Roles"
Mouse roles are only partially supported.
.PP
.Vb 3
\& package R1 {
\&   use Mouse:Role;
\& }
\& 
\& package R2 {
\&   use Mouse:Role;
\&   use Sub::HandlesVia;
\&   
\&   # define some attributes with delegation
\& }
\& 
\& # This class is broken.
\& package C1 {
\&   use Mouse;
\&   with \*(AqR1\*(Aq, \*(AqR2\*(Aq;
\& }
\& 
\& # This class should work.
\& package C2 {
\&   use Mouse;
\&   with \*(AqR1\*(Aq;
\&   with \*(AqR2\*(Aq;
\& }
.Ve
.PP
For details, see <https://github.com/tobyink/p5\-sub\-handlesvia/issues/9>.
.PP
Patches to fix the issue are very welcome!
.SS "Which Methods Can Be Delegated To?"
.IX Subsection "Which Methods Can Be Delegated To?"
The \f(CW\*(C`handles_via\*(C'\fR option indicates which library of methods should be
available. Valid values include
Array,
Blessed,
Bool,
Code,
Counter,
Enum,
Hash,
Number,
Scalar, and
String.
.PP
An arrayref can be provided for \f(CW\*(C`handles_via\*(C'\fR, though many of the options
are conceptually contradictory.
.PP
.Vb 1
\& handles_via => [ \*(AqNumber\*(Aq, \*(AqScalar\*(Aq ]
.Ve
.SS "Mouse Native Types"
.IX Subsection "Mouse Native Types"
Although the synopsis shows Types::Standard being used for type constraints,
Mouse native types should also work fine.
.PP
.Vb 3
\& package Kitchen {
\&   use Mouse;
\&   use Sub::HandlesVia;
\&   
\&   has food => (
\&     is          => \*(Aqro\*(Aq,
\&     isa         => \*(AqArrayRef[Str]\*(Aq,
\&     handles_via => \*(AqArray\*(Aq,
\&     default     => sub { [] },
\&     handles     => {
\&       \*(Aqadd_food\*(Aq    => \*(Aqpush\*(Aq,
\&       \*(Aqfind_food\*(Aq   => \*(Aqgrep\*(Aq,
\&     },
\&   );
\& }
.Ve
.SS "True MouseX::NativeTraits Drop-In Syntax"
.IX Subsection "True MouseX::NativeTraits Drop-In Syntax"
Sub::HandlesVia will also recognize MouseX::NativeTraits\-style
\&\f(CW\*(C`traits\*(C'\fR. It will jump in and handle them before MouseX::NativeTraits
notices!
.PP
.Vb 3
\& package Kitchen {
\&   use Mouse;
\&   use Sub::HandlesVia;
\&   
\&   has food => (
\&     is          => \*(Aqro\*(Aq,
\&     isa         => \*(AqArrayRef[Str]\*(Aq,
\&     traits      => [\*(AqArray\*(Aq],
\&     default     => sub { [] },
\&     handles     => {
\&       \*(Aqadd_food\*(Aq    => \*(Aqpush\*(Aq,
\&       \*(Aqfind_food\*(Aq   => \*(Aqgrep\*(Aq,
\&     },
\&   );
\& }
.Ve
.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"
Misc advanced documentation:
Sub::HandlesVia::Manual::Advanced.
.PP
Sub::HandlesVia.
.PP
Documentation for delegatable methods:
Sub::HandlesVia::HandlerLibrary::Array,
Sub::HandlesVia::HandlerLibrary::Blessed,
Sub::HandlesVia::HandlerLibrary::Bool,
Sub::HandlesVia::HandlerLibrary::Code,
Sub::HandlesVia::HandlerLibrary::Counter,
Sub::HandlesVia::HandlerLibrary::Enum,
Sub::HandlesVia::HandlerLibrary::Hash,
Sub::HandlesVia::HandlerLibrary::Number,
Sub::HandlesVia::HandlerLibrary::Scalar, and
Sub::HandlesVia::HandlerLibrary::String.
.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"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0