Struct OneBased 

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

A one-based terminal coordinate or dimension.

Terminal protocols generally count rows and columns from 1, while Rust collections and many application models count from 0. OneBased stores the protocol value and rejects zero. Use Self::from_zero_based when converting from an application index and Self::get_zero_based when converting back.

Examples

use termina::OneBased;

let column = OneBased::from_zero_based(4);
assert_eq!(column.get(), 5);
assert_eq!(column.get_zero_based(), 4);
assert!(OneBased::new(0).is_none());

Implementation Notes

This reimplements the coordinate helper from termwiz escape helpers on top of NonZeroU16.

Implementations

impl OneBased

pub const fn new(n: u16) -> Option<Self>

Creates a one-based value from an already one-based integer.

Returns None for zero because zero is not a valid terminal row, column, or dimension in the escape sequences modeled by Termina.

pub const fn from_zero_based(n: u16) -> Self

Converts a zero-based application index into a one-based terminal value.

This panics when n is u16::MAX, because adding one would overflow the stored NonZeroU16.

pub const fn get(self) -> u16

Returns the stored one-based value.

pub const fn get_zero_based(self) -> u16

Converts the stored terminal value back to a zero-based application index.

Trait Implementations

impl Clone for OneBased

fn clone(&self) -> OneBased

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OneBased

impl Debug for OneBased

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

Formats the value using the given formatter.

impl Default for OneBased

fn default() -> Self

Returns the “default value” for a type.

impl Display for OneBased

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

Formats the value using the given formatter.

impl Eq for OneBased

impl From<NonZero<u16>> for OneBased

fn from(n: NonZeroU16) -> Self

Converts to this type from the input type.

impl PartialEq for OneBased

fn eq(&self, other: &OneBased) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OneBased