13 releases (breaking)

0.11.0 Jan 9, 2021
0.9.0 May 17, 2020
0.8.0 Apr 15, 2020
0.7.0 Feb 22, 2020
0.4.0 Jun 30, 2019

#33 in Command-line interface

Download history 549/week @ 2020-09-25 649/week @ 2020-10-02 784/week @ 2020-10-09 509/week @ 2020-10-16 676/week @ 2020-10-23 647/week @ 2020-10-30 568/week @ 2020-11-06 539/week @ 2020-11-13 236/week @ 2020-11-20 604/week @ 2020-11-27 546/week @ 2020-12-04 753/week @ 2020-12-11 291/week @ 2020-12-18 143/week @ 2020-12-25 429/week @ 2021-01-01 650/week @ 2021-01-08

2,259 downloads per month
Used in 5 crates

MIT license

720KB
16K SLoC

Terminal Wizardry

This is a rust crate that provides a number of support functions for applications interested in either displaying data to a terminal or in building a terminal emulator.

It is currently in active development and subject to fairly wild sweeping changes.

Included functionality:

  • Surface models a terminal display and its component Cells
  • Terminal attributes are aware of modern features such as True Color, Hyperlinks and will also support sixel and iterm style terminal graphics display.
  • Surfaces include a log of Changes and an API for consuming and applying deltas. This is a powerful building block for synchronizing screen instances.
  • Escape sequence parser decodes inscrutable escape sequences and gives them semantic meaning, making the code that uses them clearer. The decoded escapes can be re-encoded, allowing applications to start with the semantic meaning and emit the appropriate escape sequence without embedding obscure binary bytes.
  • Capabilities allows probing for terminal capabilities that may not be included in the system terminfo database, and overriding them in an embedding application.
  • Terminal trait provides an abstraction over unix style ttys and Windows style console APIs. Changes from Surface can be rendered to Terminals. Terminals allow decoding mouse and keyboard inputs in both blocking or non-blocking mode.
  • Widget trait allows composition of UI elements at a higher level.
  • LineEditor implements shell-like line editing functionality.

Windows Support

Termwiz understands how to work with both the legacy console APIs and the new PTY and virtual terminal features available in Windows 10, allowing for true color terminal applications on Windows 10.

Documentation

https://docs.rs/termwiz

Dependencies

~6MB
~126K SLoC