Enum DisplayWidth 

pub enum DisplayWidth {
    Narrow = 1,
    Wide = 2,
}

Represents the display width of a character in East Asian contexts

Variants

Narrow = 1

Narrow character (width 1)

Wide = 2

Wide character (width 2)

Implementations

impl DisplayWidth

pub const fn as_u8(self) -> u8

Returns the numeric width value

pub const fn as_usize(self) -> usize

Returns the numeric width value as usize (common for string operations)

Examples found in repository

examples/text_alignment.rs (line 19)

fn display_width(text: &str) -> usize {
    text.chars()
        .map(|c| east_asian_width(c as u32).as_usize())
        .sum()
}

examples/terminal_width.rs (line 11)

fn terminal_width(text: &str) -> usize {
    text.chars()
        .map(|c| east_asian_width(c as u32).as_usize())
        .sum()
}

/// Calculate width with configurable ambiguous character handling
fn terminal_width_with_config(text: &str, ambiguous_as_wide: bool) -> usize {
    text.chars()
        .map(|c| east_asian_width((c as u32, ambiguous_as_wide)).as_usize())
        .sum()
}

/// Pad a string to a specific width for terminal alignment
fn pad_to_width(text: &str, target_width: usize) -> String {
    let current_width = terminal_width(text);
    if current_width >= target_width {
        text.to_string()
    } else {
        let padding = " ".repeat(target_width - current_width);
        format!("{}{}", text, padding)
    }
}

/// Truncate a string to fit within a specific width
fn truncate_to_width(text: &str, max_width: usize) -> String {
    let mut result = String::new();
    let mut current_width = 0;

    for ch in text.chars() {
        let char_width = east_asian_width(ch as u32).as_usize();
        if current_width + char_width > max_width {
            break;
        }
        result.push(ch);
        current_width += char_width;
    }

    result
}

Trait Implementations

impl Clone for DisplayWidth

fn clone(&self) -> DisplayWidth

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisplayWidth

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<DisplayWidth> for u8

fn from(width: DisplayWidth) -> Self

Converts to this type from the input type.

impl From<DisplayWidth> for usize

fn from(width: DisplayWidth) -> Self

Converts to this type from the input type.

impl Hash for DisplayWidth

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DisplayWidth

fn eq(&self, other: &DisplayWidth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisplayWidth

impl Eq for DisplayWidth

impl StructuralPartialEq for DisplayWidth