Struct Position 

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

Position in the terminal coordinate system.

The position is relative to the top left corner of the terminal window, with the top left corner being (0, 0). The x axis is horizontal increasing to the right, and the y axis is vertical increasing downwards.

Position is used throughout the layout system to represent specific points in the terminal. It can be created from coordinates, tuples, or extracted from rectangular areas.

Construction

• new - Create a new position from x and y coordinates
• default - Create at origin (0, 0)

Conversion

• from((u16, u16)) - Create from (u16, u16) tuple
• from(Rect) - Create from Rect (uses top-left corner)
• [into((u16, u16))] - Convert to (u16, u16) tuple

Movement

• offset - Move by an Offset
• Add<Offset> and Sub<Offset> - Shift by offsets with clamping
• AddAssign<Offset> and SubAssign<Offset> - In-place shifting

Examples

use ratatui_core::layout::{Offset, Position, Rect};

// the following are all equivalent
let position = Position { x: 1, y: 2 };
let position = Position::new(1, 2);
let position = Position::from((1, 2));
let position = Position::from(Rect::new(1, 2, 3, 4));

// position can be converted back into the components when needed
let (x, y) = position.into();

// movement by offsets
let position = Position::new(5, 5) + Offset::new(2, -3);
assert_eq!(position, Position::new(7, 2));

For comprehensive layout documentation and examples, see the layout module.

Fields

x: u16

The x coordinate of the position

The x coordinate is relative to the left edge of the terminal window, with the left edge being 0.

y: u16

The y coordinate of the position

The y coordinate is relative to the top edge of the terminal window, with the top edge being 0.

Implementations

impl Position

pub const ORIGIN: Position

Position at the origin, the top left edge at 0,0

pub const MIN: Position = Self::ORIGIN

Position at the minimum x and y values

pub const MAX: Position

Position at the maximum x and y values

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

Create a new position

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

Moves the position by the given offset.

Positive offsets move right and down, negative offsets move left and up. Values that would move the position outside the u16 range are clamped to the nearest edge.

Trait Implementations

impl Add<Offset> for Position

fn add(self, offset: Offset) -> Position

Moves the position by the given offset.

Values that would move the position outside the u16 range are clamped to the nearest edge.

type Output = Position

The resulting type after applying the + operator.

impl Add<Position> for Offset

fn add(self, position: Position) -> Position

Moves the position by the given offset.

Values that would move the position outside the u16 range are clamped to the nearest edge.

type Output = Position

The resulting type after applying the + operator.

impl AddAssign<Offset> for Position

fn add_assign(&mut self, offset: Offset)

Moves the position in place by the given offset.

Values that would move the position outside the u16 range are clamped to the nearest edge.

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 Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Position

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Position

fn deserialize<__D>( __deserializer: __D, ) -> Result<Position, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Position

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

Formats the value using the given formatter.

impl From<(u16, u16)> for Position

fn from(_: (u16, u16)) -> Position

Converts to this type from the input type.

impl From<Position> for Offset

fn from(position: Position) -> Offset

Converts to this type from the input type.

impl From<Rect> for Position

fn from(rect: Rect) -> Position

Converts to this type from the input type.

impl Hash for Position

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 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 Serialize for Position

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Offset> for Position

fn sub(self, offset: Offset) -> Position

Moves the position by the inverse of the given offset.

Values that would move the position outside the u16 range are clamped to the nearest edge.

type Output = Position

The resulting type after applying the - operator.

impl SubAssign<Offset> for Position

fn sub_assign(&mut self, offset: Offset)

Moves the position in place by the inverse of the given offset.

Values that would move the position outside the u16 range are clamped to the nearest edge.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position