.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Moose::Meta::Attribute::Native::Trait::Counter 3"
.TH Moose::Meta::Attribute::Native::Trait::Counter 3 2026-10-01 "perl v5.44.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 SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyHomePage;
\&  use Moose;
\&
\&  has \*(Aqcounter\*(Aq => (
\&      traits  => [\*(AqCounter\*(Aq],
\&      is      => \*(Aqro\*(Aq,
\&      isa     => \*(AqNum\*(Aq,
\&      default => 0,
\&      handles => {
\&          inc_counter   => \*(Aqinc\*(Aq,
\&          dec_counter   => \*(Aqdec\*(Aq,
\&          reset_counter => \*(Aqreset\*(Aq,
\&      },
\&  );
\&
\&  my $page = MyHomePage\->new();
\&  $page\->inc_counter;    # same as $page\->counter( $page\->counter + 1 );
\&  $page\->dec_counter;    # same as $page\->counter( $page\->counter \- 1 );
\&
\&  my $count_by_twos = 2;
\&  $page\->inc_counter($count_by_twos);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This trait provides native delegation methods for counters. A counter can be
any sort of number (integer or not). The delegation methods allow you to
increment, decrement, or reset the value.
.SH "DEFAULT TYPE"
.IX Header "DEFAULT TYPE"
If you don\*(Aqt provide an \f(CW\*(C`isa\*(C'\fR value for your attribute, it will default to
\&\f(CW\*(C`Num\*(C'\fR.
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
.IP \(bu 4
\&\fBset($value)\fR
.Sp
Sets the counter to the specified value and returns the new value.
.Sp
This method requires a single argument.
.IP \(bu 4
\&\fBinc\fR
.IP \(bu 4
\&\fBinc($arg)\fR
.Sp
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 \(bu 4
\&\fBdec\fR
.IP \(bu 4
\&\fBdec($arg)\fR
.Sp
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 \(bu 4
\&\fBreset\fR
.Sp
Resets the value stored in this slot to its default value, and returns the new
value.
.SH BUGS
.IX Header "BUGS"
See "BUGS" in Moose for details on reporting bugs.