Struct ratatui::backend::TermionBackend
source · pub struct TermionBackend<W>where
W: Write,{ /* private fields */ }Implementations§
source§impl<W> TermionBackend<W>where
W: Write,
impl<W> TermionBackend<W>where W: Write,
pub fn new(stdout: W) -> TermionBackend<W> ⓘ
Trait Implementations§
source§impl<W> Backend for TermionBackend<W>where
W: Write,
impl<W> Backend for TermionBackend<W>where W: Write,
source§fn hide_cursor(&mut self) -> Result<()>
fn hide_cursor(&mut self) -> Result<()>
Hides cursor
source§fn show_cursor(&mut self) -> Result<()>
fn show_cursor(&mut self) -> Result<()>
Shows cursor
source§fn clear_region(&mut self, clear_type: ClearType) -> Result<()>
fn clear_region(&mut self, clear_type: ClearType) -> Result<()>
ClearType parameterfn draw<'a, I>(&mut self, content: I) -> Result<()>where I: Iterator<Item = (u16, u16, &'a Cell)>,
fn flush(&mut self) -> Result<()>
source§impl<W> Write for TermionBackend<W>where
W: Write,
impl<W> Write for TermionBackend<W>where W: Write,
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored)Auto Trait Implementations§
impl<W> RefUnwindSafe for TermionBackend<W>where W: RefUnwindSafe,
impl<W> Send for TermionBackend<W>where W: Send,
impl<W> Sync for TermionBackend<W>where W: Sync,
impl<W> Unpin for TermionBackend<W>where W: Unpin,
impl<W> UnwindSafe for TermionBackend<W>where W: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<W> DetectColors for Wwhere
W: Write,
impl<W> DetectColors for Wwhere W: Write,
source§impl<W> DetectCursorPos for Wwhere
W: Write,
impl<W> DetectCursorPos for Wwhere W: Write,
source§impl<T> ExecutableCommand for Twhere
T: Write + ?Sized,
impl<T> ExecutableCommand for Twhere T: Write + ?Sized,
source§fn execute(&mut self, command: impl Command) -> Result<&mut T, Error>
fn execute(&mut self, command: impl Command) -> Result<&mut T, Error>
Executes the given command directly.
The given command its ANSI escape code will be written and flushed onto Self.
Arguments
-
The command that you want to execute directly.
Example
use std::io::{Write, stdout};
use crossterm::{Result, ExecutableCommand, style::Print};
fn main() -> Result<()> {
// will be executed directly
stdout()
.execute(Print("sum:\n".to_string()))?
.execute(Print(format!("1 + 1= {} ", 1 + 1)))?;
Ok(())
// ==== Output ====
// sum:
// 1 + 1 = 2
}Have a look over at the Command API for more details.
Notes
- In the case of UNIX and Windows 10, ANSI codes are written to the given ‘writer’.
- In case of Windows versions lower than 10, a direct WinAPI call will be made.
The reason for this is that Windows versions lower than 10 do not support ANSI codes,
and can therefore not be written to the given
writer. Therefore, there is no difference between execute and queue for those old Windows versions.
source§impl<W> IntoAlternateScreen for Wwhere
W: Write,
impl<W> IntoAlternateScreen for Wwhere W: Write,
source§fn into_alternate_screen(self) -> Result<AlternateScreen<Self>, Error>
fn into_alternate_screen(self) -> Result<AlternateScreen<Self>, Error>
AlternateScreen returned by this function is
dropped.source§impl<W> IntoRawMode for Wwhere
W: Write,
impl<W> IntoRawMode for Wwhere W: Write,
source§fn into_raw_mode(self) -> Result<RawTerminal<W>, Error>
fn into_raw_mode(self) -> Result<RawTerminal<W>, Error>
source§impl<T> QueueableCommand for Twhere
T: Write + ?Sized,
impl<T> QueueableCommand for Twhere T: Write + ?Sized,
source§fn queue(&mut self, command: impl Command) -> Result<&mut T, Error>
fn queue(&mut self, command: impl Command) -> Result<&mut T, Error>
Queues the given command for further execution.
Queued commands will be executed in the following cases:
- When
flushis called manually on the given type implementingio::Write. - The terminal will
flushautomatically if the buffer is full. - Each line is flushed in case of
stdout, because it is line buffered.
Arguments
-
The command that you want to queue for later execution.
Examples
use std::io::{Write, stdout};
use crossterm::{Result, QueueableCommand, style::Print};
fn main() -> Result<()> {
let mut stdout = stdout();
// `Print` will executed executed when `flush` is called.
stdout
.queue(Print("foo 1\n".to_string()))?
.queue(Print("foo 2".to_string()))?;
// some other code (no execution happening here) ...
// when calling `flush` on `stdout`, all commands will be written to the stdout and therefore executed.
stdout.flush()?;
Ok(())
// ==== Output ====
// foo 1
// foo 2
}Have a look over at the Command API for more details.
Notes
- In the case of UNIX and Windows 10, ANSI codes are written to the given ‘writer’.
- In case of Windows versions lower than 10, a direct WinAPI call will be made.
The reason for this is that Windows versions lower than 10 do not support ANSI codes,
and can therefore not be written to the given
writer. Therefore, there is no difference between execute and queue for those old Windows versions.
source§impl<W> SynchronizedUpdate for Wwhere
W: Write + ?Sized,
impl<W> SynchronizedUpdate for Wwhere W: Write + ?Sized,
source§fn sync_update<T>(
&mut self,
operations: impl FnOnce(&mut W) -> T
) -> Result<T, Error>
fn sync_update<T>( &mut self, operations: impl FnOnce(&mut W) -> T ) -> Result<T, Error>
Performs a set of actions within a synchronous update.
Updates will be suspended in the terminal, the function will be executed against self, updates will be resumed, and a flush will be performed.
Arguments
-
Function
A function that performs the operations that must execute in a synchronized update.
Examples
use std::io::{Write, stdout};
use crossterm::{Result, ExecutableCommand, SynchronizedUpdate, style::Print};
fn main() -> Result<()> {
let mut stdout = stdout();
stdout.sync_update(|stdout| {
stdout.execute(Print("foo 1\n".to_string()))?;
stdout.execute(Print("foo 2".to_string()))?;
// The effects of the print command will not be present in the terminal
// buffer, but not visible in the terminal.
crossterm::Result::Ok(())
})?;
// The effects of the commands will be visible.
Ok(())
// ==== Output ====
// foo 1
// foo 2
}Notes
This command is performed only using ANSI codes, and will do nothing on terminals that do not support ANSI codes, or this specific extension.
When rendering the screen of the terminal, the Emulator usually iterates through each visible grid cell and renders its current state. With applications updating the screen a at higher frequency this can cause tearing.
This mode attempts to mitigate that.
When the synchronization mode is enabled following render calls will keep rendering the last rendered state. The terminal Emulator keeps processing incoming text and sequences. When the synchronized update mode is disabled again the renderer may fetch the latest screen buffer state again, effectively avoiding the tearing effect by unintentionally rendering in the middle a of an application screen update.