104 releases (14 breaking)

0.15.2 Aug 22, 2024
0.15.0 Apr 17, 2024
0.14.0 Mar 31, 2024
0.12.0 Nov 29, 2023
0.1.3 May 26, 2021

#99 in Command-line interface

Download history 2/week @ 2024-05-22 3/week @ 2024-05-29 2219/week @ 2024-06-05 324/week @ 2024-06-12 5/week @ 2024-07-03 108/week @ 2024-07-31 23/week @ 2024-08-07 2/week @ 2024-08-14 125/week @ 2024-08-21 5/week @ 2024-08-28

165 downloads per month

MIT license

425KB
11K SLoC

Surf-N-Term

Build Status MIT License Crate API Docs

This crate is used to interact with Posix terminal. It can be used to

  • Read events from the terminal
  • Send commands to the terminal
  • Render on a surface which will be reconciled with current content of the terminal
  • Issue direct commends to the terminal
  • Supports kitty/sixel image protocol

Simple example

use surf_n_term::{Terminal, TerminalEvent, Error};

fn main() -> Result<(), Error> {
    let ctrl_c = TerminalEvent::Key("ctrl+c".parse()?);
    let mut term = SystemTerminal::new()?;
    term.run_render(|term, event, mut view| -> Result<_, Error> {
        // This function will be executed on each event from terminal
        // - term  - implements Terminal trait
        // - event - is a TerminalEvent
        // - view  - is a Surface that can be used to render on, see render module for details
        match event {
            Some(event) if &event == &ctrl_c => {
                // exit if 'ctrl+c' is pressed
                Ok(TerminalAction::Quit(()))
            }
            _ => {
                // do some rendering by updating the view
                Ok(TerminalAction::Wait)
            },
        }
    })?;
    Ok(())
}

Full examples can be found in example submodule

$ cargo run --example mandelbrot
$ cargo run --example mouse
$ cargo run --example events

Used by

  • you should checkout my sweep program to interactively filter through list of items

Dependencies

~6MB
~111K SLoC