Enum AmbiguousWidthTreatment 

pub enum AmbiguousWidthTreatment {
    Narrow,
    Wide,
}

How to treat ambiguous width characters

Some Unicode characters have ambiguous width properties, meaning their display width depends on the context (terminal, font, locale, etc.). This enum allows you to specify how such characters should be treated.

Examples

use string_width::{AmbiguousWidthTreatment, StringWidthOptions, string_width_with_options};

let text = "±×÷";  // Ambiguous width characters

let narrow_options = StringWidthOptions {
    count_ansi: false,
    ambiguous_width: AmbiguousWidthTreatment::Narrow,
};
assert_eq!(string_width_with_options(text, narrow_options), 3);

let wide_options = StringWidthOptions {
    count_ansi: false,
    ambiguous_width: AmbiguousWidthTreatment::Wide,
};
assert_eq!(string_width_with_options(text, wide_options), 6);

Variants

Narrow

Treat ambiguous characters as narrow (width 1)

Wide

Treat ambiguous characters as wide (width 2)

Trait Implementations

impl Clone for AmbiguousWidthTreatment

fn clone(&self) -> AmbiguousWidthTreatment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AmbiguousWidthTreatment

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

Formats the value using the given formatter.

impl Default for AmbiguousWidthTreatment

fn default() -> Self

Returns the default treatment for ambiguous width characters.

The default is Narrow, which treats ambiguous characters as having width 1. This is the most common behavior in terminal applications.

impl PartialEq for AmbiguousWidthTreatment

fn eq(&self, other: &AmbiguousWidthTreatment) -> 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 AmbiguousWidthTreatment

impl Eq for AmbiguousWidthTreatment

impl StructuralPartialEq for AmbiguousWidthTreatment