https://github.com/Aetf/unicode-truncate

Rust library for unicode-aware algorithm to pad or truncate `str` in terms of displayed width.
https://github.com/Aetf/unicode-truncate

padding rust truncate unicode width

Last synced: 3 months ago
JSON representation

Rust library for unicode-aware algorithm to pad or truncate `str` in terms of displayed width.

• Host: GitHub
• URL: https://github.com/Aetf/unicode-truncate
• Owner: Aetf
• License: other
• Created: 2019-08-15T01:24:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-17T22:55:51.000Z (over 3 years ago)
• Last Synced: 2024-03-17T07:44:33.430Z (3 months ago)
• Topics: padding, rust, truncate, unicode, width
• Language: Rust
• Homepage:
• Size: 35.2 KB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Lists

• awesome-stars - Aetf/unicode-truncate - Rust library for unicode-aware algorithm to pad or truncate `str` in terms of displayed width. (Rust)

README

        
# unicode-truncate

Unicode-aware algorithm to pad or truncate `str` in terms of displayed width.

[![crates.io](https://img.shields.io/crates/v/unicode-truncate.svg)](https://crates.io/crates/unicode-truncate)

[![Documentation](https://docs.rs/unicode-truncate/badge.svg)](https://docs.rs/unicode-truncate)

[![Build Status](https://travis-ci.com/Aetf/unicode-truncate.svg)](https://travis-ci.com/Aetf/unicode-truncate)

## examples

Safely truncate string to display width even not at character boundaries.

```rust

use unicode_truncate::UnicodeTruncateStr;

fn main() {

    let (rv, w) = "你好吗".unicode_truncate(5);

    assert_eq!(rv, "你好");

    assert_eq!(w, 4);

}

```

Making sure the string is displayed in exactly number of columns by combining padding

and truncating.

```rust

use unicode_truncate::UnicodeTruncateStr;

use unicode_truncate::Alignment;

use unicode_width::UnicodeWidthStr;

fn main() {

    let rv = "你好吗".unicode_pad(5, Alignment::Left, true);

    assert_eq!(rv, "你好 ");

    assert_eq!(rv.width(), 5);

}

```

## features

`unicode-truncate` can be built without libstd by disabling the default feature `std`. However in that

case `unicode_truncate::UnicodeTruncateStr::unicode_pad` won't be available because it depends on

`std::string::String` and `std::borrow::Cow`.