pub struct CrosstermBackend<W> { /* private fields */ }Expand description
A backend that uses the crossterm library.
Implementations§
Source§impl<W> CrosstermBackend<W>
impl<W> CrosstermBackend<W>
Sourcepub fn new(buffer: W) -> CrosstermBackend<W> ⓘ
pub fn new(buffer: W) -> CrosstermBackend<W> ⓘ
Creates a new CrosstermBackend
Trait Implementations§
Source§impl<W: Write> Backend for CrosstermBackend<W>
impl<W: Write> Backend for CrosstermBackend<W>
Source§fn enable_raw_mode(&mut self) -> Result<()>
fn enable_raw_mode(&mut self) -> Result<()>
Enables raw mode.
Source§fn disable_raw_mode(&mut self) -> Result<()>
fn disable_raw_mode(&mut self) -> Result<()>
Disables raw mode.
Source§fn hide_cursor(&mut self) -> Result<()>
fn hide_cursor(&mut self) -> Result<()>
Hides the cursor.
Source§fn show_cursor(&mut self) -> Result<()>
fn show_cursor(&mut self) -> Result<()>
Shows the cursor.
Source§fn get_cursor_pos(&mut self) -> Result<(u16, u16)>
fn get_cursor_pos(&mut self) -> Result<(u16, u16)>
Gets the cursor position as (col, row). The top-left cell is (0, 0).
Source§fn move_cursor_to(&mut self, x: u16, y: u16) -> Result<()>
fn move_cursor_to(&mut self, x: u16, y: u16) -> Result<()>
Moves the cursor to given position. The top-left cell is (0, 0).
Source§fn move_cursor(&mut self, direction: MoveDirection) -> Result<()>
fn move_cursor(&mut self, direction: MoveDirection) -> Result<()>
Moves the cursor relative to the current position as per the
direction.Source§fn scroll(&mut self, dist: i16) -> Result<()>
fn scroll(&mut self, dist: i16) -> Result<()>
Scrolls the terminal the given number of rows. Read more
Source§fn set_attributes(&mut self, attributes: Attributes) -> Result<()>
fn set_attributes(&mut self, attributes: Attributes) -> Result<()>
Sets the given
attributes removing ones which were previous applied.Source§impl<W: Clone> Clone for CrosstermBackend<W>
impl<W: Clone> Clone for CrosstermBackend<W>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<W: Debug> Debug for CrosstermBackend<W>
impl<W: Debug> Debug for CrosstermBackend<W>
Source§impl<W: Write> Write for CrosstermBackend<W>
impl<W: Write> Write for CrosstermBackend<W>
Source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Writes a buffer into this writer, returning how many bytes were written. Read more
Source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flushes this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
Source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector)1.0.0 · Source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
Source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
write_all_vectored)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations§
impl<W> Freeze for CrosstermBackend<W>where
W: Freeze,
impl<W> RefUnwindSafe for CrosstermBackend<W>where
W: RefUnwindSafe,
impl<W> Send for CrosstermBackend<W>where
W: Send,
impl<W> Sync for CrosstermBackend<W>where
W: Sync,
impl<W> Unpin for CrosstermBackend<W>where
W: Unpin,
impl<W> UnwindSafe for CrosstermBackend<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
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 T
impl<T> ExecutableCommand for T
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> 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>
Switch to raw mode. Read more
Source§impl<T> QueueableCommand for T
impl<T> QueueableCommand for T
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.