Struct TerminalCursor

pub struct TerminalCursor {
    pub row: usize,
    pub col: usize,
    pub visible: bool,
    pub shape: TerminalCursorShape,
}

Zero-based cursor position and presentation state.

Public fields and deserialization may place the cursor out of bounds; call Self::clamp_to before indexing a screen.

Examples

use ailloli_ui_terminal_core::{TerminalCursor, TerminalCursorShape};
let cursor = TerminalCursor::new();
assert_eq!((cursor.row, cursor.col, cursor.visible, cursor.shape), (0, 0, true, TerminalCursorShape::Block));

Fields

row: usize

Zero-based screen row.

col: usize

Zero-based screen column.

visible: bool

Whether the renderer should show the cursor.

shape: TerminalCursorShape

Requested renderer shape.

Implementations

impl TerminalCursor

pub const fn new() -> Self

Creates a visible block cursor at row zero, column zero.

Examples

use ailloli_ui_terminal_core::TerminalCursor;
assert_eq!((TerminalCursor::new().row, TerminalCursor::new().col), (0, 0));

pub fn clamp_to(&mut self, size: TerminalSize)

Clamps row and column into a terminal size.

Zero dimensions are first clamped to one, so the result is always a valid (row, col) for TerminalSize::clamped. Visibility and shape are unchanged.

Examples

use ailloli_ui_terminal_core::{TerminalCursor, TerminalSize};
let mut cursor = TerminalCursor { row: 9, col: 9, ..TerminalCursor::new() };
cursor.clamp_to(TerminalSize { rows: 2, cols: 3 });
assert_eq!((cursor.row, cursor.col), (1, 2));

Trait Implementations

impl Clone for TerminalCursor

fn clone(&self) -> TerminalCursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalCursor

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

Formats the value using the given formatter.

impl Default for TerminalCursor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TerminalCursor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TerminalCursor

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TerminalCursor

impl Eq for TerminalCursor

impl StructuralPartialEq for TerminalCursor