Struct StringWidthOptions 

pub struct StringWidthOptions {
    pub count_ansi: bool,
    pub ambiguous_width: AmbiguousWidthTreatment,
}

Configuration options for string width calculation

This struct contains all the options that control how string width is calculated. It provides fine-grained control over various aspects of width calculation.

Examples

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

// Default options
let options = StringWidthOptions::default();
assert_eq!(string_width_with_options("Hello", options), 5);

// Custom options
let options = StringWidthOptions {
    count_ansi: true,  // Count ANSI escape sequences
    ambiguous_width: AmbiguousWidthTreatment::Wide,  // Treat ambiguous as wide
};

Fields

count_ansi: bool

Whether to count ANSI escape sequences in width calculation

When false (default), ANSI escape sequences are stripped before calculating width. When true, they are included in the calculation.

ambiguous_width: AmbiguousWidthTreatment

How to treat ambiguous width characters

Controls whether characters with ambiguous width properties are treated as narrow (width 1) or wide (width 2).

Implementations

impl StringWidthOptions

pub fn builder() -> StringWidthOptionsBuilder

Creates a new builder for StringWidthOptions

The builder pattern provides a fluent API for configuring options.

Examples

use string_width::StringWidthOptions;

let options = StringWidthOptions::builder()
    .count_ansi(true)
    .ambiguous_as_wide()
    .build();

Trait Implementations

impl Clone for StringWidthOptions

fn clone(&self) -> StringWidthOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringWidthOptions

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

Formats the value using the given formatter.

impl Default for StringWidthOptions

fn default() -> StringWidthOptions

Returns the “default value” for a type.