Struct tty_interface::Position

pub struct Position { /* private fields */ }

A coordinate position in the terminal. May be absolute or relative to some buffer’s origin.

Implementations

impl Position

pub fn new(x: u16, y: u16) -> Position

Create a new, immutable position.

Examples

use tty_interface::Position;

let origin = Position::new(2, 4);
assert_eq!(2, origin.x());
assert_eq!(4, origin.y());

pub fn x(&self) -> u16

This position’s column value.

pub fn y(&self) -> u16

This position’s line value.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Ord for Position

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Position> for Position

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Position> for Position

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Position

impl Eq for Position

impl StructuralEq for Position

impl StructuralPartialEq for Position