/ 
Data-Unixish-1.572
River stage two • 9 direct dependents • 49 total dependents
/ Data::Unixish::bool

NAME

Data::Unixish::bool - Format boolean

VERSION

This document describes version 1.572 of Data::Unixish::bool (from Perl distribution Data-Unixish), released on 2019-10-26.

SYNOPSIS

In Perl:

use Data::Unixish qw(lduxl);
my @res = lduxl([bool => {style=>"check_cross"}], [0, "one", 2, ""])
# => ("✕","✓","✓","✕")

In command line:

% echo -e "0\none\n2\n\n" | dux bool -s y_n --format=text-simple
n
y
y
n

FUNCTIONS

bool

Usage:

bool(%args) -> [status, msg, payload, meta]

Format boolean.

This function is not exported.

Arguments ('*' denotes required arguments):

  • false_char => str

    Instead of style, you can also specify character for true value.

  • in => array

    Input stream (e.g. array or filehandle).

  • notion => str (default: "perl")

    What notion to use to determine true/false.

    perl uses Perl notion.

    n1 (for lack of better name) is just like Perl notion, but empty array and empty hash is considered false.

    TODO: add Ruby, Python, PHP, JavaScript, etc notion.

  • out => any

    Output stream (e.g. array or filehandle).

  • style => str (default: "one_zero")

    Available styles:

    • Y_N: N Y

    • check (uses Unicode): ✓

    • check_cross (uses Unicode): ✕ ✓

    • dot (uses Unicode): ●

    • dot_cross (uses Unicode): ✘ ●

    • heavy_check_cross (uses Unicode): ✘ ✔

    • one_zero: 0 1

    • t_f: f t

    • true_false: false true

    • v_X: X v

    • y_n: n y

    • yes_no: no yes

  • true_char => str

    Instead of style, you can also specify character for true value.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Unixish.

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Unixish.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Unixish

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar@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.