/ 
Data-Unixish-1.56
River stage two • 9 direct dependents • 49 total dependents
/ Data::Unixish::rpad

NAME

Data::Unixish::rpad - Pad text to the right until a certain column width

VERSION

This document describes version 1.56 of Data::Unixish::rpad (from Perl distribution Data-Unixish), released on 2017-07-10.

SYNOPSIS

In Perl:

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

In command line:

% echo -e "123\n1234" | dux rpad -w 6 -c x --format=text-simple
123xxx
1234xx

FUNCTIONS

rpad

Usage:

rpad(%args) -> [status, msg, result, meta]

Pad text to the right until a certain column width.

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

Note: to pad 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

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 (result) 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) 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.