Struct requestty_ui::backend::CrosstermBackend
source · [−]pub struct CrosstermBackend<W> { /* private fields */ }
crossterm
only.Expand description
A backend that uses the crossterm
library.
Implementations
sourceimpl<W> CrosstermBackend<W>
impl<W> CrosstermBackend<W>
sourcepub fn new(buffer: W) -> CrosstermBackend<W>ⓘNotable traits for CrosstermBackend<W>impl<W: Write> Write for CrosstermBackend<W>
pub fn new(buffer: W) -> CrosstermBackend<W>ⓘNotable traits for CrosstermBackend<W>impl<W: Write> Write for CrosstermBackend<W>
Creates a new CrosstermBackend
Trait Implementations
sourceimpl<W: Write> Backend for CrosstermBackend<W>
impl<W: Write> Backend for CrosstermBackend<W>
sourcefn enable_raw_mode(&mut self) -> Result<()>
fn enable_raw_mode(&mut self) -> Result<()>
Enables raw mode.
sourcefn disable_raw_mode(&mut self) -> Result<()>
fn disable_raw_mode(&mut self) -> Result<()>
Disables raw mode.
sourcefn hide_cursor(&mut self) -> Result<()>
fn hide_cursor(&mut self) -> Result<()>
Hides the cursor.
sourcefn show_cursor(&mut self) -> Result<()>
fn show_cursor(&mut self) -> Result<()>
Shows the cursor.
sourcefn 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).
sourcefn 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).
sourcefn 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
.
sourcefn scroll(&mut self, dist: i16) -> Result<()>
fn scroll(&mut self, dist: i16) -> Result<()>
Scrolls the terminal the given number of rows. Read more
sourcefn 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.
sourceimpl<W: Clone> Clone for CrosstermBackend<W>
impl<W: Clone> Clone for CrosstermBackend<W>
sourcefn clone(&self) -> CrosstermBackend<W>ⓘNotable traits for CrosstermBackend<W>impl<W: Write> Write for CrosstermBackend<W>
fn clone(&self) -> CrosstermBackend<W>ⓘNotable traits for CrosstermBackend<W>impl<W: Write> Write for CrosstermBackend<W>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<W: Debug> Debug for CrosstermBackend<W>
impl<W: Debug> Debug for CrosstermBackend<W>
sourceimpl<W: Write> Write for CrosstermBackend<W>
impl<W: Write> Write for CrosstermBackend<W>
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn 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
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<W> DetectColors for W where
W: Write,
impl<W> DetectColors for W where
W: Write,
sourceimpl<W> DetectCursorPos for W where
W: Write,
impl<W> DetectCursorPos for W where
W: Write,
sourceimpl<T> ExecutableCommand for T where
T: Write + ?Sized,
impl<T> ExecutableCommand for T where
T: Write + ?Sized,
sourcefn 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.
sourceimpl<W> IntoRawMode for W where
W: Write,
impl<W> IntoRawMode for W where
W: Write,
sourcefn into_raw_mode(self) -> Result<RawTerminal<W>, Error>
fn into_raw_mode(self) -> Result<RawTerminal<W>, Error>
Switch to raw mode. Read more
sourceimpl<T> QueueableCommand for T where
T: Write + ?Sized,
impl<T> QueueableCommand for T where
T: Write + ?Sized,
sourcefn 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
flush
is called manually on the given type implementingio::Write
. - The terminal will
flush
automatically 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.