Struct TerminalWidth 

pub struct TerminalWidth { /* private fields */ }

A nonzero terminal width in columns.

Implementations

impl TerminalWidth

pub const fn new(columns: u16) -> Result<TerminalWidth, TerminalDimensionError>

Creates a terminal width.

Errors

Returns [TerminalDimensionError::ZeroWidth] when columns is zero.

pub const fn columns(self) -> u16

Returns the width in columns.

Trait Implementations

impl Clone for TerminalWidth

fn clone(&self) -> TerminalWidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalWidth

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

Formats the value using the given formatter.

impl Hash for TerminalWidth

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

where __H: Hasher,

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 Ord for TerminalWidth

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

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

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

impl Eq for TerminalWidth

impl StructuralPartialEq for TerminalWidth