Steven Haryanto

NAME

Data::Unixish::trunc - Truncate string to a certain column width

VERSION

version 1.32

SYNOPSIS

In Perl:

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

In command line:

 % echo -e "123\n1234\n12345" | dux trunc -w 4 --format=text-simple
 123
 1234
 1234

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.

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

Truncate string to a certain column width.

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

Note: to truncate by character 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.

  • 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).

  • 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.