Skip to main content

Scrollback

Struct Scrollback 

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

Scrollback buffer with configurable line capacity.

Uses a VecDeque for O(1) push/pop. When over capacity, the oldest line (front of the deque) is evicted.

Implementations§

Source§

impl Scrollback

Source

pub fn new(capacity: usize) -> Self

Create a new scrollback with the given line capacity.

A capacity of 0 means scrollback is disabled (all pushes are dropped).

Source

pub fn capacity(&self) -> usize

Maximum number of lines this scrollback can hold.

Source

pub fn set_capacity(&mut self, capacity: usize)

Change the scrollback capacity.

If the new capacity is smaller than the current line count, the oldest lines are evicted.

Source

pub fn len(&self) -> usize

Current number of stored lines.

Source

pub fn is_empty(&self) -> bool

Whether the scrollback is empty.

Source

pub fn push_row( &mut self, cells: &[Cell], wrapped: bool, ) -> Option<ScrollbackLine>

Push a row (as a cell slice) into scrollback.

wrapped indicates whether the row was a soft-wrap continuation. If over capacity, the oldest line is evicted.

Source

pub fn pop_newest(&mut self) -> Option<ScrollbackLine>

Pop the most recent (newest) line from scrollback.

Used when scrolling down to pull lines back into the viewport, or when the viewport grows taller and lines are reclaimed.

Source

pub fn peek_newest(&self) -> Option<&ScrollbackLine>

Peek at the most recent (newest) line without removing it.

Source

pub fn get(&self, index: usize) -> Option<&ScrollbackLine>

Get a line by index (0 = oldest).

Source

pub fn iter(&self) -> impl Iterator<Item = &ScrollbackLine>

Iterate over stored lines from oldest to newest.

Source

pub fn iter_range( &self, range: Range<usize>, ) -> impl Iterator<Item = &ScrollbackLine>

Iterate over a specific line range (0 = oldest).

The range is clamped to valid bounds. This enables viewport virtualization without scanning the full history each frame.

Source

pub fn iter_rev(&self) -> impl Iterator<Item = &ScrollbackLine>

Iterate over stored lines from newest to oldest.

Source

pub fn clear(&mut self)

Clear all stored lines.

Source

pub fn virtualized_window( &self, scroll_offset_from_bottom: usize, viewport_lines: usize, overscan_lines: usize, ) -> ScrollbackWindow

Compute a virtualized scrollback window for viewport rendering.

  • scroll_offset_from_bottom=0 anchors viewport at the newest lines.
  • Larger offsets move viewport toward older lines.
  • overscan_lines expands the render range around the viewport.

Trait Implementations§

Source§

impl Clone for Scrollback

Source§

fn clone(&self) -> Scrollback

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 Scrollback

Source§

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

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

impl Default for Scrollback

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.