Grid

Struct Grid 

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

Terminal grid with scrollback buffer

Uses VecDeque to efficiently manage scrollback history. The visible rows are at the end of the deque, with scrollback history at the front.

Implementations§

Source§

impl Grid

Source

pub fn new(size: Size, scrollback_len: usize) -> Self

Create a new grid

Source

pub fn size(&self) -> Size

Get the grid size

Source

pub fn pos(&self) -> Pos

Get cursor position

Source

pub fn set_pos(&mut self, pos: Pos)

Set cursor position

Source

pub fn set_col(&mut self, col: u16)

Move cursor to column

Source

pub fn set_row(&mut self, row: u16)

Move cursor to row

Source

pub fn save_pos(&mut self)

Save cursor position

Source

pub fn restore_pos(&mut self)

Restore cursor position

Source

pub fn scrollback(&self) -> usize

Get current scrollback offset

Source

pub fn set_scrollback(&mut self, offset: usize)

Set scrollback offset

Source

pub fn scrollback_available(&self) -> usize

Get available scrollback lines

Source

pub fn set_scroll_region(&mut self, top: u16, bottom: u16)

Set scroll region

Source

pub fn reset_scroll_region(&mut self)

Reset scroll region to full screen

Source

pub fn visible_row(&self, row: u16) -> Option<&Row>

Get a visible row (accounting for scrollback offset)

Source

pub fn drawing_row(&self, row: u16) -> Option<&Row>

Get a drawing row (for writing, ignores scrollback offset)

Source

pub fn drawing_row_mut(&mut self, row: u16) -> Option<&mut Row>

Get a mutable drawing row

Source

pub fn current_row(&self) -> Option<&Row>

Get current row (at cursor position)

Source

pub fn current_row_mut(&mut self) -> Option<&mut Row>

Get mutable current row

Source

pub fn scroll_up(&mut self, count: usize)

Scroll up within scroll region

Source

pub fn scroll_down(&mut self, count: usize)

Scroll down within scroll region

Source

pub fn clear(&mut self)

Clear all rows

Source

pub fn clear_below(&mut self)

Clear from cursor to end of screen

Source

pub fn clear_above(&mut self)

Clear from start of screen to cursor

Source

pub fn resize(&mut self, new_size: Size)

Resize the grid

Source

pub fn get_selected_text( &self, low_x: i32, low_y: i32, high_x: i32, high_y: i32, ) -> String

Get selected text from coordinates

Handles wrapped lines correctly (no newline for soft-wrapped rows)

Source

pub fn visible_rows(&self) -> impl Iterator<Item = &Row>

Iterate over visible rows

Source

pub fn drawing_rows(&self) -> impl Iterator<Item = &Row>

Iterate over drawing rows (ignoring scrollback offset)

Trait Implementations§

Source§

impl Clone for Grid

Source§

fn clone(&self) -> Grid

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 Grid

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Grid

§

impl RefUnwindSafe for Grid

§

impl Send for Grid

§

impl Sync for Grid

§

impl Unpin for Grid

§

impl UnwindSafe for Grid

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more