Scroll to navigation

Sub::HandlesVia::HandlerLibrary::Counter(3pm) User Contributed Perl Documentation Sub::HandlesVia::HandlerLibrary::Counter(3pm)

NAME

Sub::HandlesVia::HandlerLibrary::Counter - library of counter-related methods

SYNOPSIS

  package My::Class {
    use Moo;
    use Sub::HandlesVia;
    use Types::Standard 'Int';
    has attr => (
      is => 'rwp',
      isa => Int,
      handles_via => 'Counter',
      handles => {
        'my_dec' => 'dec',
        'my_inc' => 'inc',
        'my_reset' => 'reset',
        'my_set' => 'set',
      },
    );
  }

DESCRIPTION

This is a library of methods for Sub::HandlesVia.

DELEGATABLE METHODS

dec( $amount? )

Arguments: Optional[Int].

Decrements the counter by $amount, or by 1 if no value is given.

  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

inc( $amount? )

Arguments: Optional[Int].

Increments the counter by $amount, or by 1 if no value is given.

  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

reset()

Sets the counter to its default value, or 0 if it has no default.

  my $object = My::Class->new( attr => 10 );
  $object->my_reset;
  say $object->attr; ## ==> 0

set( $value )

Arguments: Int.

Sets the counter to the given value.

  my $object = My::Class->new( attr => 0 );
  $object->my_set( 5 );
  say $object->attr; ## ==> 5

BUGS

Please report any bugs to <https://github.com/tobyink/p5-sub-handlesvia/issues>.

SEE ALSO

Sub::HandlesVia.

AUTHOR

Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE

This software is copyright (c) 2020, 2022 by Toby Inkster.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

2024-09-15 perl v5.38.2