NAME

Data::Unixish::lpad - Pad text to the left until a certain column width

VERSION

version 1.39

SYNOPSIS

In Perl:

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

In command line:

% echo -e "123\n1234" | dux lpad -w 6 -c x --format=text-simple
xxx123
xx1234

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

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

DESCRIPTION

FUNCTIONS

None are exported by default, but they are exportable.

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

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.

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 => any

  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

Return 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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.