.\" 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::WithObjectPad 3pm"
.TH Sub::HandlesVia::Manual::WithObjectPad 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::WithObjectPad \- using Sub::HandlesVia with Object::Pad
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Object::Pad;
\& 
\& class Kitchen {
\&   has @foods;
\&   use Sub::HandlesVia::Declare \*(Aq@foods\*(Aq, Array => (
\&     all_foods => \*(Aqall\*(Aq,
\&     add_food  => \*(Aqpush\*(Aq,
\&   );
\& }
.Ve
.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
Experimental Object::Pad support is provided by Sub::HandlesVia,
including for array and hash fields.
.PP
Object::Pad classes are \*(L"sealed\*(R" after compile time, preventing new
methods from being installed at run-time. (It's actually trivially
easy to add them at runtime, but not using the \s-1API\s0 provided by the
Object::Pad \s-1MOP,\s0 so we don't do that.) This is why Sub::Handles::Declare
is used, as it creates delegated methods at compile-time.
.PP
The first argument is the field name, including its sigil.
.PP
The second argument is the handler library. If the field name
begins with a '@' or '%', this is implied to be \*(L"Array\*(R"/\*(L"Hash\*(R".
.PP
.Vb 1
\& use Object::Pad;
\& 
\& class Kitchen {
\&   has @foods;
\&   use Sub::HandlesVia::Declare \*(Aq@foods\*(Aq, (
\&     all_foods => \*(Aqall\*(Aq,
\&     add_food  => \*(Aqpush\*(Aq,
\&   );
\& }
.Ve
.PP
The third argument is a hash of methods to delegate.
.SS "Which Methods Can Be Delegated To?"
.IX Subsection "Which Methods Can Be Delegated To?"
The second parameter (\*(L"Array\*(R" in the synopsis) 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, though many of the options are conceptually
contradictory.
.PP
.Vb 3
\& use Sub::HandlesVia::Declare \*(Aqnum\*(Aq, [ \*(AqNumber\*(Aq, \*(AqScalar\*(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, Sub::HandlesVia::Declare.
.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