.\" -*- 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 "Data::Perl::Role::Counter 3"
.TH Data::Perl::Role::Counter 3 2024-09-01 "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
Data::Perl::Role::Counter \- Wrapping class for a simple numeric counter.
.SH VERSION
.IX Header "VERSION"
version 0.002011
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Data::Perl qw/counter/;
\&
\&  my $c = counter(4);
\&
\&  $c\->inc;   # $c == 5
\&
\&  $c\->reset; # $c == 0
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class provides a wrapper and methods for a simple numeric counter.
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
.IP \fBnew($value)\fR 4
.IX Item "new($value)"
Constructs a new Data::Perl::Collection::Counter object initialized with the passed
in value, and returns it.
.IP \fBset($value)\fR 4
.IX Item "set($value)"
Sets the counter to the specified value and returns the new value.
.Sp
This method requires a single argument.
.IP \fBinc\fR 4
.IX Item "inc"
.PD 0
.IP \fBinc($arg)\fR 4
.IX Item "inc($arg)"
.PD
Increases the attribute value by the amount of the argument, or by 1 if no
argument is given. This method returns the new value.
.Sp
This method accepts a single argument.
.IP \fBdec\fR 4
.IX Item "dec"
.PD 0
.IP \fBdec($arg)\fR 4
.IX Item "dec($arg)"
.PD
Decreases the attribute value by the amount of the argument, or by 1 if no
argument is given. This method returns the new value.
.Sp
This method accepts a single argument.
.IP \fBreset\fR 4
.IX Item "reset"
Resets the value stored in this slot to its default value, and returns the new
value.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
Data::Perl
.IP \(bu 4
MooX::HandlesVia
.SH AUTHOR
.IX Header "AUTHOR"
Matthew Phillips <mattp@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020 by Matthew Phillips <mattp@cpan.org>.
.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.