Data::Perl::Role::Bool (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Data::Perl::Role::Bool.3pm".)

NAME

Data::Perl::Role::Bool - Wrapping class for boolean values.

VERSION

version 0.002009

SYNOPSIS

  use Data::Perl qw/bool/;

  my $bool = bool(0);

  $bool->toggle; # 1

  $bool->unset; # 0

DESCRIPTION

This class provides a wrapper and methods for interacting with boolean values.

PROVIDED METHODS

None of these methods accept arguments.

new($value)

Constructs a new Data::Perl::Collection::Bool object initialized with the passed in value, and returns it.

set

Sets the value to 1 and returns 1.

unset

Set the value to 0 and returns 0.

toggle

Toggles the value. If it's true, set to false, and vice versa.

Returns the new value.

not

Equivalent of 'not $value'.

SEE ALSO

*

Data::Perl

*

MooX::HandlesVia

AUTHOR

Matthew Phillips <mattp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Matthew Phillips <mattp@cpan.org>.

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