[−][src]Struct crossterm::RawScreen
A raw screen.
Be aware that the raw mode is disabled when you drop the RawScreen
value.
Call the keep_raw_mode_on_drop
method to disable this behavior (keep the raw mode enabled).
Examples
Basic usage:
use crossterm::{RawScreen, Result}; fn main() -> Result<()> { let _raw = RawScreen::into_raw_mode()?; // Do something in the raw mode Ok(()) } // `_raw` is dropped here <- raw mode is disabled
Do not disable the raw mode implicitly:
use crossterm::{RawScreen, Result}; fn main() -> Result<()> { let mut raw = RawScreen::into_raw_mode()?; raw.keep_raw_mode_on_drop(); // Feel free to leave `raw` on it's own/drop it, the raw // mode won't be disabled // Do something in the raw mode // Disable raw mode explicitly RawScreen::disable_raw_mode() }
Methods
impl RawScreen
[src]
pub fn into_raw_mode() -> Result<RawScreen>
[src]
Enables raw mode.
pub fn disable_raw_mode() -> Result<()>
[src]
Disables raw mode.
pub fn keep_raw_mode_on_drop(&mut self)
[src]
Keeps the raw mode enabled when self
is dropped.
See the RawScreen
documentation for more
information.
Trait Implementations
Auto Trait Implementations
impl Send for RawScreen
impl Sync for RawScreen
impl Unpin for RawScreen
impl UnwindSafe for RawScreen
impl RefUnwindSafe for RawScreen
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
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> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,