[−][src]Struct crossterm::AlternateScreen
With this type you will be able to switch to the alternate screen and then back to the main screen. Check also the Screen type for switching to alternate mode.
Although this type is available for you to use I would recommend using Screen
instead.
Methods
impl AlternateScreen
[src]
pub fn to_alternate(raw_mode: bool) -> Result<AlternateScreen, Error>
[src]
Switch to the alternate screen. This function will return an AlternateScreen
instance if everything went well. This type will give you control over the AlternateScreen
.
The bool specifies whether the screen should be in raw mode or not.
What is Alternate screen?
*Nix style applications often utilize an alternate screen buffer, so that they can modify the entire contents of the buffer without affecting the application that started them. The alternate buffer dimensions are exactly the same as the window, without any scrollback region. For an example of this behavior, consider when vim is launched from bash. Vim uses the entirety of the screen to edit the file, then returning to bash leaves the original buffer unchanged.
pub fn to_main(&self) -> Result<(), Error>
[src]
Switch the alternate screen back to the main screen.
Trait Implementations
impl Drop for AlternateScreen
[src]
Auto Trait Implementations
impl Sync for AlternateScreen
impl Send for AlternateScreen
impl Unpin for AlternateScreen
impl RefUnwindSafe for AlternateScreen
impl UnwindSafe for AlternateScreen
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,