Enum ratatui::terminal::Viewport

pub enum Viewport {
    Fullscreen,
    Inline(u16),
    Fixed(Rect),
}

Represents the viewport of the terminal. The viewport is the area of the terminal that is currently visible to the user. It can be either fullscreen, inline or fixed.

When the viewport is fullscreen, the whole terminal is used to draw the application.

When the viewport is inline, it is drawn inline with the rest of the terminal. The height of the viewport is fixed, but the width is the same as the terminal width.

When the viewport is fixed, it is drawn in a fixed area of the terminal. The area is specified by a Rect.

See Terminal::with_options for more information.

Variants

Fullscreen

The viewport is fullscreen

Inline(u16)

The viewport is inline with the rest of the terminal.

The viewport’s height is fixed and specified in number of lines. The width is the same as the terminal’s width. The viewport is drawn below the cursor position.

Fixed(Rect)

The viewport is drawn in a fixed area of the terminal. The area is specified by a Rect.

Trait Implementations

impl Clone for Viewport

fn clone(&self) -> Viewport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Viewport

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

Formats the value using the given formatter.

impl Default for Viewport

fn default() -> Viewport

Returns the “default value” for a type.

impl Display for Viewport

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

Formats the value using the given formatter.

impl Hash for Viewport

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Viewport

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

impl StructuralPartialEq for Viewport