https://github.com/unicode-rs/unicode-width

Displayed width of Unicode characters and strings according to UAX#11 rules.
https://github.com/unicode-rs/unicode-width

Last synced: 7 days ago
JSON representation

Displayed width of Unicode characters and strings according to UAX#11 rules.

• Host: GitHub
• URL: https://github.com/unicode-rs/unicode-width
• Owner: unicode-rs
• License: other
• Created: 2015-04-13T22:59:38.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T06:28:57.000Z (about 2 months ago)
• Last Synced: 2024-10-29T12:03:29.302Z (15 days ago)
• Language: Rust
• Homepage: https://unicode-rs.github.io/unicode-width
• Size: 870 KB
• Stars: 215
• Watchers: 8
• Forks: 26
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# `unicode-width`

[![Build status](https://github.com/unicode-rs/unicode-width/actions/workflows/rust.yml/badge.svg)](https://github.com/unicode-rs/unicode-width/actions/workflows/rust.yml)

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

[![Docs status](https://img.shields.io/docsrs/unicode-width)](https://docs.rs/unicode-width/)

Determine displayed width of `char` and `str` types according to [Unicode Standard Annex #11][UAX11]

and other portions of the Unicode standard.

This crate is `#![no_std]`.

[UAX11]: http://www.unicode.org/reports/tr11/

```rust

use unicode_width::UnicodeWidthStr;

fn main() {

    let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";

    let width = teststr.width();

    println!("{}", teststr);

    println!("The above string is {} columns wide.", width);

    let width = teststr.width_cjk();

    println!("The above string is {} columns wide (CJK).", width);

}

```

**NOTE:** The computed width values may not match the actual rendered column

width. For example, many Brahmic scripts like Devanagari have complex rendering rules

which this crate does not currently handle (and will never fully handle, because

the exact rendering depends on the font):

```rust

extern crate unicode_width;

use unicode_width::UnicodeWidthStr;

fn main() {

    assert_eq!("क".width(), 1); // Devanagari letter Ka

    assert_eq!("ष".width(), 1); // Devanagari letter Ssa

    assert_eq!("क्ष".width(), 2); // Ka + Virama + Ssa

}

```

Additionally, [defective combining character sequences](https://unicode.org/glossary/#defective_combining_character_sequence)

and nonstandard [Korean jamo](https://unicode.org/glossary/#jamo) sequences may

be rendered with a different width than what this crate says. (This is not an

exhaustive list.) For a list of what this crate *does* handle, see

[docs.rs](https://docs.rs/unicode-width/latest/unicode_width/#rules-for-determining-width).

## crates.io

You can use this package in your project by adding the following

to your `Cargo.toml`:

```toml

[dependencies]

unicode-width = "0.1.11"

```