The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Hydrogen-0.018
River stage zero No dependents
2 ++
/ Hydrogen::Bool

NAME

Hydrogen::Bool - a standard library for booleans

VERSION

This documentation is for Hydrogen::Bool 0.018, which is based on Sub::HandlesVia::HandlerLibrary::Bool 0.046.

FUNCTIONS

Each function expects a scalar which will be treated as a boolean as its first argument.

not( $bool )

Returns the opposite value of the boolean.

reset( $bool )

Sets the boolean to its default value, or false if it has no default.

set( $bool )

Sets the value of the boolean to true.

toggle( $bool )

Toggles the truth value of the boolean.

unset( $bool )

Sets the value of the boolean to false.

EXPORT

No functions are exported by this module by default. To import them all (this is usually a bad idea), use:

    use Hydrogen::Bool -all;

To import a particular function, use:

    use Hydrogen::Bool 'set';

To rename functions:

    use Hydrogen::Bool 'set' => { -as => 'myfunc' };

On Perl 5.37.2+, you can import lexically:

    use Hydrogen::Bool -lexical, 'set';

See Exporter::Tiny::Manual::Importing for more hints on importing.

BUGS

Please report any bugs to http://github.com/tobyink/p5-hydrogen/issues.

SEE ALSO

Hydrogen, Hydrogen::Curry::Bool, Hydrogen::Topic::Bool, Sub::HandlesVia::HandlerLibrary::Bool.

AUTHOR

Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE

This software is copyright (c) 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.