Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-21 20:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix: remove _defaults, rename to restore

Browse source
This commit is contained in:
Josh McKinney 2024-06-20 19:12:07 -07:00
parent c98e778185
commit 48d6c5ab4a
No known key found for this signature in database
GPG key ID: 722287396A903BC5
3 changed files with 29 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
examples/colors_rgb.rs
View file

@ -97,7 +97,7 @@ struct ColorsWidget {
fn main() -> Result<()> {
install_error_hooks()?;
let backend = CrosstermBackend::stdout_with_defaults()?;
let backend = CrosstermBackend::stdout()?;
let terminal = Terminal::new(backend)?;
App::default().run(terminal)?;
Ok(())
@ -268,11 +268,11 @@ fn install_error_hooks() -> Result<()> {
let panic = panic.into_panic_hook();
let error = error.into_eyre_hook();
eyre::set_hook(Box::new(move |e| {
let _ = CrosstermBackend::reset(stdout());
let _ = CrosstermBackend::restore(stdout());
error(e)
}))?;
panic::set_hook(Box::new(move |info| {
let _ = CrosstermBackend::reset(stdout());
let _ = CrosstermBackend::restore(stdout());
panic(info);
}));
Ok(())

2
examples/minimal.rs
View file

@ -27,7 +27,7 @@ use ratatui::{
/// [examples]: https://github.com/ratatui-org/ratatui/blob/main/examples
/// [hello-world]: https://github.com/ratatui-org/ratatui/blob/main/examples/hello_world.rs
fn main() -> Result<(), Box<dyn std::error::Error>> {
let backend = CrosstermBackend::stdout_with_defaults()?;
let backend = CrosstermBackend::stdout()?;
let mut terminal = Terminal::new(backend)?;
terminal.clear()?;
loop {

74
src/backend/crossterm.rs
View file

@ -36,10 +36,8 @@ use crate::{
/// cursor, and clearing the terminal screen.
///
/// Convenience methods ([`CrosstermBackend::stdout`] and [`CrosstermBackend::stderr`] are provided
/// to create a `CrosstermBackend` with [`std::io::stdout`] or [`std::io::stderr`] as the writer.
/// Additionally, these can be created with default settings to enable raw mode and switch to the
/// alternate screen using [`CrosstermBackend::stdout_with_defaults`] or
/// [`CrosstermBackend::stderr_with_defaults`].
/// to create a `CrosstermBackend` with [`std::io::stdout`] or [`std::io::stderr`] as the writer
/// with default settings to enable raw mode and switch to the alternate screen.
///
/// If the default settings are not desired, the `CrosstermBackend` can be configured using the
/// `with_*` methods. These methods return an [`io::Result`] containing self so that they can be
@ -62,11 +60,11 @@ use crate::{
/// crossterm::event::KeyboardEnhancementFlags,
/// };
///
/// let backend = CrosstermBackend::stdout_with_defaults()?;
/// let backend = CrosstermBackend::stdout()?;
/// // or
/// let backend = CrosstermBackend::stderr_with_defaults()?;
/// let backend = CrosstermBackend::stderr()?;
/// // or with custom settings
/// let backend = CrosstermBackend::stdout()
/// let backend = CrosstermBackend::new(std::io::stdout())
/// .with_raw_mode()?
/// .with_alternate_screen()?
/// .with_mouse_capture()?
@ -148,7 +146,10 @@ where
}
impl CrosstermBackend<io::Stdout> {
/// Creates a new `CrosstermBackend` with `std::io::stdout`.
/// Creates a new `CrosstermBackend` with `std::io::stdout`, enables raw mode, and switches to
/// the alternate screen.
///
/// Raw mode and alternate screen are restored when the `CrosstermBackend` is dropped.
///
/// # Example
///
@ -156,30 +157,18 @@ impl CrosstermBackend<io::Stdout> {
/// # use ratatui::backend::CrosstermBackend;
/// let backend = CrosstermBackend::stdout();
/// ```
pub fn stdout() -> Self {
pub fn stdout() -> io::Result<Self> {
Self::new(io::stdout())
}
/// Creates a new `CrosstermBackend` with `std::io::stdout` and default settings.
///
/// This enables raw mode and switches to the alternate screen. Mouse support is not enabled.
///
/// Raw mode and alternate screen are restored when the `CrosstermBackend` is dropped.
///
/// # Example
///
/// ```rust,no_run
/// # use ratatui::backend::CrosstermBackend;
/// let backend = CrosstermBackend::stdout_with_defaults()?;
/// # std::io::Result::Ok(())
/// ```
pub fn stdout_with_defaults() -> io::Result<Self> {
Self::stdout().with_raw_mode()?.with_alternate_screen()
.with_raw_mode()?
.with_alternate_screen()
}
}
impl CrosstermBackend<io::Stderr> {
/// Creates a new `CrosstermBackend` with `std::io::stderr`.
/// Creates a new `CrosstermBackend` with `std::io::stderr`, enables raw mode, and switches to
/// the alternate screen.
///
/// Raw mode and alternate screen are restored when the `CrosstermBackend` is dropped.
///
/// # Example
///
@ -187,25 +176,10 @@ impl CrosstermBackend<io::Stderr> {
/// # use ratatui::backend::CrosstermBackend;
/// let backend = CrosstermBackend::stderr();
/// ```
pub fn stderr() -> Self {
pub fn stderr() -> io::Result<Self> {
Self::new(io::stderr())
}
/// Creates a new `CrosstermBackend` with `std::io::stderr` and default settings.
///
/// This enables raw mode and switches to the alternate screen. Mouse support is not enabled.
///
/// Raw mode and alternate screen are restored when the `CrosstermBackend` is dropped.
///
/// # Example
///
/// ```rust,no_run
/// # use ratatui::backend::CrosstermBackend;
/// let backend = CrosstermBackend::stderr_with_defaults()?;
/// # std::io::Result::Ok(())
/// ```
pub fn stderr_with_defaults() -> io::Result<Self> {
Self::stderr().with_raw_mode()?.with_alternate_screen()
.with_raw_mode()?
.with_alternate_screen()
}
}
@ -322,11 +296,13 @@ impl<W: Write> CrosstermBackend<W> {
Ok(self)
}
/// Resets the terminal to its default state.
/// Restores the terminal to its default state.
///
/// This method:
///
/// - Disables raw mode
/// - Disables mouse capture
/// - Leaves the alternate screen
/// - Disables mouse capture
/// - Disables bracketed paste
/// - Disables focus change
/// - Pops keyboard enhancement flags
@ -343,10 +319,10 @@ impl<W: Write> CrosstermBackend<W> {
///
/// ```rust,no_run
/// # use ratatui::backend::CrosstermBackend;
/// CrosstermBackend::reset(std::io::stderr())?;
/// CrosstermBackend::restore(std::io::stderr())?;
/// # std::io::Result::Ok(())
/// ```
pub fn reset(mut writer: W) -> io::Result<()> {
pub fn restore(mut writer: W) -> io::Result<()> {
disable_raw_mode()?;
execute!(
writer,