Struct Position 

pub struct Position {
    pub x: u16,
    pub y: u16,
}

A point in the terminal coordinate system.

Fields

x: u16

Column index (0-based).

y: u16

Row index (0-based).

Implementations

impl Position

pub const MAX: Self

The largest possible position.

pub const MIN: Self = Self::ORIGIN

The smallest possible position (same as ORIGIN).

pub const ORIGIN: Self

The origin (0, 0).

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

Create a new position with the given x and y values.

pub fn offset(self, offset: Offset) -> Self

Apply an offset, clamping to valid u16 range.

Trait Implementations

impl Add<Offset> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, offset: Offset) -> Self::Output

Performs the + operation.

impl AddAssign<Offset> for Position

fn add_assign(&mut self, offset: Offset)

Performs the += operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl From<(u16, u16)> for Position

fn from((x, y): (u16, u16)) -> Self

Converts to this type from the input type.

impl From<Position> for (u16, u16)

fn from(position: Position) -> Self

Converts to this type from the input type.

impl From<Rect> for Position

fn from(rect: Rect) -> Self

Converts to this type from the input type.

impl Hash for Position

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

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 Position

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

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

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

impl Sub<Offset> for Position

type Output = Position

The resulting type after applying the - operator.

fn sub(self, offset: Offset) -> Self::Output

Performs the - operation.

impl SubAssign<Offset> for Position

fn sub_assign(&mut self, offset: Offset)

Performs the -= operation.