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 screen, taking into account ANSI escape sequences and Unicode character widths. It provides type safety to prevent confusion between byte lengths and display widths.

Examples

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);

// Ordering works as expected
assert!(Width::new(10) < Width::new(20));

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);

Trait Implementations

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 From<usize> for Width

fn from(value: usize) -> Self

Converts to this type from the input type.

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 Copy for Width

impl Eq for Width

impl StructuralPartialEq for Width