Crate bwrap

Source
Expand description

A fast, lightweight, embedded systems-friendly library for wrapping text.

While Bwrap offers great flexibility in wrapping text, neither resource consumption nor performance compromises:

  1. No heap allocation happens by default.
  2. The time/space complexity is O(n) by default, or O(n(p+a)) if there is appending/prepending. (n, p, a is the number of input/prepended/appended bytes respectively)

For the sake of readability, we (b)etter wrap our text.

§Features

use_std: Use standard library for automatic memory management. (disable by default)

§Examples

Note: These examples require use_std feature.

Wrap a long line of text:

let original = "
one two three one two three one two three
";
let wrapped = bwrap::wrap!(original, 13);

let expected = "
one two three
one two three
one two three
";
assert_eq!(wrapped, expected);

Format CLI error messages:

let original = "
error: TLS handshake erorr.
  tip: Probably because of instable network connection, please try these solutions: Retry the connection; Use another different network; Use another version of TLS; Reboot your system; Reinstall your system; Give up.
";
let wrapped = bwrap::wrap_nobrk!(original, 38, "       ");

let expected = "
error: TLS handshake erorr.
  tip: Probably because of instable
       network connection, please try these
       solutions: Retry the connection; Use
       another different network; Use another
       version of TLS; Reboot your system;
       Reinstall your system; Give up.
";
assert_eq!(wrapped, expected);

Format a bullet list:

let original = "
Here is our schedule:
- Do A, and do B, and do C, and do D, and do E, and do F
- Do G, and do H, and do I, and do J, and do K, and do L
";
let wrapped = bwrap::wrap_nobrk!(original, 35, "  ");

let expected = "
Here is our schedule:
- Do A, and do B, and do C, and do
  D, and do E, and do F
- Do G, and do H, and do I, and do
  J, and do K, and do L
";
assert_eq!(wrapped, expected);

Trailing notation:

let original = "
VGhpcyBpcyBhIHNlY3JldCBtZXNzYWdlLCBwbGVhc2UgZGVsZXRlIGFmdGVyIHJlYWQK
";
let wrapped = bwrap::wrap_maybrk!(original, 10, " |");

let expected = "
VGhpcyBpcy |
BhIHNlY3Jl |
dCBtZXNzYW |
dlLCBwbGVh |
c2UgZGVsZX |
RlIGFmdGVy |
IHJlYWQK
";
assert_eq!(wrapped, expected);

More exmaples/benchmark can be found in repository.

Macros§

wrapuse_std
Wrap text in default style.
wrap_maybrkuse_std
Wrap text in May-Break style.
wrap_nobrkuse_std
Wrap text in Non-Break style.

Structs§

EasyWrapperuse_std
A type for the actual wrapping tasks.
Wrapper
A type for the actual wrapping tasks.

Enums§

ExistNlPref
Preference for existing newlines.
WrapError
The internal errors.
WrapStyle
The wrapping style used by Wrapper.

Type Aliases§

Result