Enum text_terminal::ScrollPosition

pub enum ScrollPosition {
    Top,
    AtUnit(ScrollbackBufferPoint),
    Bottom(ScrollbackBufferPoint),
}

The position (“viewport”) that the terminal is currently scrolled to.

By default, the terminal starts at the Bottom, such that it will auto-scroll upon new characters being displayed.

Variants

Top

The terminal is scrolled all the way up.

In this position, the terminal screen “viewport” is locked and will NOT auto-scroll down to show any newly-outputted lines of text.

AtUnit(ScrollbackBufferPoint)

The terminal is scrolled to a specific point, given by the contained ScrollbackBufferPoint that points to the Unit that will be displayed in the upper-left hand corner of the screen viewport.

In this position, the terminal screen “viewport” is locked and will NOT auto-scroll down to show any newly-outputted lines of text.

Bottom(ScrollbackBufferPoint)

The terminal position is scrolled all the way down.

In this position, the terminal screen “viewport” is NOT locked and will auto-scroll down to show any newly-outputted lines of text.

For convenience in calculating the screen viewport, the contained fields are the same as in the AtUnit variant.

In this mode, the contained point must be updated whenever the screen is scrolled down by virtue of a new line being displayed at the bottom. the screen viewport is scrolled up or down.

Trait Implementations

impl Clone for ScrollPosition

fn clone(&self) -> ScrollPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollPosition

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

Formats the value using the given formatter.

impl Default for ScrollPosition

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<ScrollPosition> for ScrollPosition

fn eq(&self, other: &ScrollPosition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ScrollPosition

impl Eq for ScrollPosition

impl StructuralEq for ScrollPosition

impl StructuralPartialEq for ScrollPosition