Struct Width 

pub struct Width(/* private fields */);

A type-safe wrapper for display width values.

This type represents the visual width of text as it would appear on a terminal or console, correctly accounting for:

• ANSI escape sequences (which have zero display width)
• Unicode characters with varying display widths
• Multi-byte characters that occupy single or double terminal columns

The Width type prevents common bugs by distinguishing between:

• Byte length: The number of bytes in a string (str.len())
• Character count: The number of Unicode scalar values (str.chars().count())
• Display width: The number of terminal columns occupied when rendered

Why Display Width Matters

Consider these examples:

• "hello" has 5 bytes, 5 characters, and 5 display width
• "古古古" has 9 bytes, 3 characters, and 6 display width (CJK characters are wide)
• "\x1b[31mred\x1b[0m" has 11 bytes, 7 characters, and 3 display width (ANSI codes are invisible)

Examples

Basic Usage

use ansi_align::Width;

let width = Width::new(42);
assert_eq!(width.get(), 42);

// Convert from usize
let width: Width = 24.into();
assert_eq!(width.get(), 24);

Comparison and Ordering

use ansi_align::Width;

let small = Width::new(10);
let large = Width::new(20);

assert!(small < large);
assert_eq!(Width::new(15), Width::new(15));

// Can be used in collections
let mut widths = vec![Width::new(30), Width::new(10), Width::new(20)];
widths.sort();
assert_eq!(widths, vec![Width::new(10), Width::new(20), Width::new(30)]);

Integration with String Width Calculation

use ansi_align::Width;
// Note: This example shows the concept, actual width calculation
// is done internally by the library

let display_width = Width::new(5); // Represents 5 terminal columns
let padding_needed = 10 - display_width.get(); // 5 columns of padding

Implementations

impl Width

pub const fn new(value: usize) -> Self

Creates a new Width value from a usize.

Arguments

• value - The display width value

Examples

use ansi_align::Width;

let width = Width::new(10);
assert_eq!(width.get(), 10);

pub const fn get(self) -> usize

Returns the underlying usize value.

Examples

use ansi_align::Width;

let width = Width::new(42);
assert_eq!(width.get(), 42);

pub const fn saturating_sub(self, other: Self) -> Self

Performs saturating subtraction, returning 0 if the result would be negative.

Arguments

• other - The Width value to subtract

Examples

use ansi_align::Width;

let w1 = Width::new(10);
let w2 = Width::new(15);
assert_eq!(w1.saturating_sub(w2).get(), 0); // 10 - 15 = 0 (saturated)

let w3 = Width::new(20);
assert_eq!(w3.saturating_sub(w1).get(), 10); // 20 - 10 = 10

pub const fn is_zero(self) -> bool

Returns true if the width is zero.

Examples

use ansi_align::Width;

assert!(Width::new(0).is_zero());
assert!(!Width::new(5).is_zero());

Trait Implementations

impl Add for Width

fn add(self, rhs: Self) -> Self::Output

Adds two Width values.

Examples

use ansi_align::Width;

let w1 = Width::new(10);
let w2 = Width::new(5);
assert_eq!((w1 + w2).get(), 15);

type Output = Width

The resulting type after applying the + operator.

impl Clone for Width

fn clone(&self) -> Width

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Width

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

Formats the value using the given formatter.

impl Display for Width

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

Formats the Width value for display.

Examples

use ansi_align::Width;

let width = Width::new(42);
assert_eq!(format!("{}", width), "42");

impl Div for Width

fn div(self, rhs: Self) -> Self::Output

Divides one Width value by another.

Examples

use ansi_align::Width;

let w1 = Width::new(10);
let w2 = Width::new(5);
assert_eq!((w1 / w2).get(), 2);

type Output = Width

The resulting type after applying the / operator.

impl From<usize> for Width

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Mul for Width

fn mul(self, rhs: Self) -> Self::Output

Multiplies two Width values.

Examples

use ansi_align::Width;

let w1 = Width::new(10);
let w2 = Width::new(5);
assert_eq!((w1 * w2).get(), 50);

type Output = Width

The resulting type after applying the * operator.

impl Ord for Width

fn cmp(&self, other: &Width) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Width

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

fn partial_cmp(&self, other: &Width) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Width

fn sub(self, rhs: Self) -> Self::Output

Subtracts one Width value from another.

Examples

use ansi_align::Width;

let w1 = Width::new(10);
let w2 = Width::new(5);
assert_eq!((w1 - w2).get(), 5);

type Output = Width

The resulting type after applying the - operator.

impl Copy for Width

impl Eq for Width

impl StructuralPartialEq for Width