.\" 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::HandlerLibrary::Counter 3pm" .TH Sub::HandlesVia::HandlerLibrary::Counter 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::HandlerLibrary::Counter \- library of counter\-related methods .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 10 \& package My::Class { \& use Moo; \& use Sub::HandlesVia; \& use Types::Standard \*(AqInt\*(Aq; \& has attr => ( \& is => \*(Aqrwp\*(Aq, \& isa => Int, \& handles_via => \*(AqCounter\*(Aq, \& handles => { \& \*(Aqmy_dec\*(Aq => \*(Aqdec\*(Aq, \& \*(Aqmy_inc\*(Aq => \*(Aqinc\*(Aq, \& \*(Aqmy_reset\*(Aq => \*(Aqreset\*(Aq, \& \*(Aqmy_set\*(Aq => \*(Aqset\*(Aq, \& }, \& ); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a library of methods for Sub::HandlesVia. .SH "DELEGATABLE METHODS" .IX Header "DELEGATABLE METHODS" .ie n .SS """dec( $amount? )""" .el .SS "\f(CWdec( $amount? )\fP" .IX Subsection "dec( $amount? )" Arguments: \fBOptional[Int]\fR. .PP Decrements the counter by \f(CW$amount\fR, or by 1 if no value is given. .PP .Vb 6 \& my $object = My::Class\->new( attr => 10 ); \& $object\->my_dec; \& $object\->my_dec; \& say $object\->attr; ## ==> 8 \& $object\->my_dec( 5 ); \& say $object\->attr; ## ==> 3 .Ve .ie n .SS """inc( $amount? )""" .el .SS "\f(CWinc( $amount? )\fP" .IX Subsection "inc( $amount? )" Arguments: \fBOptional[Int]\fR. .PP Increments the counter by \f(CW$amount\fR, or by 1 if no value is given. .PP .Vb 6 \& my $object = My::Class\->new( attr => 0 ); \& $object\->my_inc; \& $object\->my_inc; \& say $object\->attr; ## ==> 2 \& $object\->my_inc( 3 ); \& say $object\->attr; ## ==> 5 .Ve .ie n .SS """reset()""" .el .SS "\f(CWreset()\fP" .IX Subsection "reset()" Sets the counter to its default value, or 0 if it has no default. .PP .Vb 3 \& my $object = My::Class\->new( attr => 10 ); \& $object\->my_reset; \& say $object\->attr; ## ==> 0 .Ve .ie n .SS """set( $value )""" .el .SS "\f(CWset( $value )\fP" .IX Subsection "set( $value )" Arguments: \fBInt\fR. .PP Sets the counter to the given value. .PP .Vb 3 \& my $object = My::Class\->new( attr => 0 ); \& $object\->my_set( 5 ); \& say $object\->attr; ## ==> 5 .Ve .SH "BUGS" .IX Header "BUGS" Please report any bugs to . .SH "SEE ALSO" .IX Header "SEE ALSO" Sub::HandlesVia. .SH "AUTHOR" .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2020, 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