/ 
Data-Unixish-1.573
River stage two • 9 direct dependents • 49 total dependents
/ Data::Unixish::centerpad

NAME

Data::Unixish::centerpad - Center text to a certain column width

VERSION

This document describes version 1.573 of Data::Unixish::centerpad (from Perl distribution Data-Unixish), released on 2023-09-23.

SYNOPSIS

In Perl:

use Data::Unixish qw(lduxl);
my @res = lduxl([centerpad => {width=>6}], "123", "1234"); # => (" 123  ", " 1234 ")

In command line:

% echo -e "123\n1234" | dux centerpad -w 10 -c x --format=text-simple
xxx123xxxx
xxx1234xxx

FUNCTIONS

centerpad

Usage:

centerpad(%args) -> [$status_code, $reason, $payload, \%result_meta]

Center text to a certain column width.

This function can handle text containing wide characters and ANSI escape codes.

Note: to center to a certain character length instead of column width (note that wide characters like Chinese can have width of more than 1 column in terminal), you can turn of mb option even when your text contains wide characters.

This function is not exported.

Arguments ('*' denotes required arguments):

  • ansi => bool (default: 0)

    Whether to handle ANSI escape codes.

  • char => str (default: " ")

    Character to use for padding.

    Character should have column width of 1. The default is space (ASCII 32).

  • in => array

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

  • mb => bool (default: 0)

    Whether to handle wide characters.

  • out => any

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

  • trunc => bool (default: 0)

    Whether to truncate text wider than specified width.

  • width* => int

    (No description)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

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.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

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

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.