Struct mortal::terminal::Cursor

pub struct Cursor {
    pub line: usize,
    pub column: usize,
}

Represents the cursor position in a terminal device

Fields

line: usize

Index of line in terminal, beginning at 0.

column: usize

Index of column in terminal, beginning at 0.

Methods

impl Cursor

pub fn next(&self, size: Size) -> Option<Cursor>

Returns the position of the next cell within a terminal of the given size.

Returns None if this cursor position represents the last cell.

pub fn previous(&self, size: Size) -> Option<Cursor>

Returns the position of the previous cell within a terminal of the given size.

Returns None if this cursor position represents the first cell.

pub fn first() -> Cursor

Returns a Cursor pointing to the first cell, i.e. (0, 0).

pub fn last(size: Size) -> Cursor

Returns a Cursor pointing to the last cell of a screen of the given size.

pub fn is_out_of_bounds(&self, size: Size) -> bool

Returns whether the cursor is out of bounds of the given size.

Trait Implementations

impl Copy for Cursor

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Cursor

Returns the "default value" for a type.

impl Eq for Cursor

impl PartialEq for Cursor

fn eq(&self, __arg_0: &Cursor) -> bool

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

fn ne(&self, __arg_0: &Cursor) -> bool

This method tests for !=.

impl From<(usize, usize)> for Cursor

fn from((line, column): (usize, usize)) -> Cursor

Returns a Cursor value from a (line, column) or (y, x) tuple.