Skip to main content

ViewCopyMode

Struct ViewCopyMode 

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

Handle for View/Copy mode

Created by ViewCopyMode::enter(), must call exit() when done.

Implementations§

Source§

impl ViewCopyMode

Source

pub fn enter<W: Write>(stdout: &mut W) -> Result<Self>

Enter View/Copy mode

This will:

  1. Leave the alternate screen
  2. Disable mouse capture
  3. Clear the screen and scrollback buffer
  4. Disable raw mode (so println works normally)
Source

pub fn enter_with_config<W: Write>( stdout: &mut W, config: ViewCopyConfig, ) -> Result<Self>

Enter View/Copy mode with custom configuration

Source

pub fn clear(&self) -> Result<()>

Clear the screen (for reprinting content)

Source

pub fn print_lines(&self, lines: &[String]) -> Result<()>

Print lines to stdout with optional header and hints

Source

pub fn print_raw(&self, lines: &[String]) -> Result<()>

Print raw lines without any formatting

Source

pub fn wait_for_input(&self) -> Result<ViewCopyAction>

Wait for user input and return the action

Note: This temporarily enables raw mode to catch keypresses, then disables it again so subsequent prints work.

Source

pub fn exit<B>(self, terminal: &mut Terminal<B>) -> Result<()>
where B: Backend, Error: From<B::Error>,

Exit View/Copy mode and return to the TUI

This will:

  1. Re-enable raw mode
  2. Re-enter the alternate screen
  3. Re-enable mouse capture
  4. Clear the terminal to force a full redraw

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> 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> 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, 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.