Struct TerminalSnapshotCursor

pub struct TerminalSnapshotCursor {
    pub row: usize,
    pub col: usize,
    pub visible: bool,
    pub shape: TerminalCursorShape,
    pub global_line: Option<u64>,
}

Snapshot cursor position and presentation.

Examples

use ailloli_ui_terminal_core::{TerminalSnapshot, TerminalSnapshotConfig, TerminalState};

let snapshot = TerminalSnapshot::from_state(&TerminalState::new(), Default::default());
assert_eq!((snapshot.cursor.row, snapshot.cursor.col), (0, 0));
assert_eq!(snapshot.cursor.global_line, Some(0));

Fields

row: usize

Zero-based row within the active screen.

col: usize

Zero-based column within the active screen.

visible: bool

Whether renderers should display the cursor.

shape: TerminalCursorShape

Requested cursor shape.

global_line: Option<u64>

Saturating normal-screen global line, or None on the alternate screen.

Trait Implementations

impl Clone for TerminalSnapshotCursor

fn clone(&self) -> TerminalSnapshotCursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalSnapshotCursor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TerminalSnapshotCursor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TerminalSnapshotCursor

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TerminalSnapshotCursor

impl StructuralPartialEq for TerminalSnapshotCursor