NAME

Data::Unixish::wrap - Wrap text

VERSION

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

SYNOPSIS

In Perl:

 use Data::Unixish qw(lduxl);
 $wrapped = lduxl([wrap => {width=>20}], "xxxx xxxx xxxx xxxx xxxx"); # "xxxx xxxx xxxx xxxx\nxxxx"

In command line:

 % echo -e "xxxx xxxx xxxx xxxx xxxx" | dux wrap -c 20
 xxxx xxxx xxxx xxxx
 xxxx

FUNCTIONS

wrap

Usage:

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

Wrap text.

This function is not exported.

Arguments ('*' denotes required arguments):

ansi => bool (default: 0)
Whether to handle ANSI escape codes.
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).
width => int (default: 80)
Target column width.

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 is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.