Skip to main content

CursorManager

Struct CursorManager 

Source
pub struct CursorManager { /* private fields */ }
Expand description

Manages cursor save/restore operations.

This struct handles the complexity of cursor save/restore across different strategies. It tracks the saved position for emulated mode and provides a unified interface regardless of the underlying mechanism.

§Contract

  • save() must be called before restore()
  • Calling restore() without a prior save() is safe but may have no effect
  • Multiple save() calls overwrite the previous save (no nesting)

Implementations§

Source§

impl CursorManager

Source

pub const fn new(strategy: CursorSaveStrategy) -> Self

Create a new cursor manager with the specified strategy.

Source

pub fn detect(caps: &TerminalCapabilities) -> Self

Create a cursor manager with auto-detected strategy.

Source

pub const fn strategy(&self) -> CursorSaveStrategy

Get the current strategy.

Source

pub fn save<W: Write>( &mut self, writer: &mut W, current_pos: (u16, u16), ) -> Result<()>

Save the cursor position.

§Arguments
  • writer - The output writer (typically stdout)
  • current_pos - Current cursor position (column, row), 0-indexed. Required for emulated mode, ignored for DEC/ANSI modes.
§Errors

Returns an error if writing to the output fails.

Source

pub fn restore<W: Write>(&self, writer: &mut W) -> Result<()>

Restore the cursor position.

§Errors

Returns an error if writing to the output fails. For emulated mode, does nothing if no position was saved.

Source

pub fn clear(&mut self)

Clear the saved position (for emulated mode).

This has no effect on DEC/ANSI modes.

Source

pub const fn saved_position(&self) -> Option<(u16, u16)>

Get the saved position (for emulated mode).

Returns None for DEC/ANSI modes or if no position was saved.

Trait Implementations§

Source§

impl Clone for CursorManager

Source§

fn clone(&self) -> CursorManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CursorManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CursorManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.