Expand description
Backend-independent terminal contracts and target-specific inspection for the Urushi ecosystem.
This crate owns vocabulary shared by terminal surfaces without depending on another Urushi workspace crate. It does not choose rendering policy, perform layout, or render a view.
§Cargo features
crosstermenables the portable Crossterm backend. The native backend is available without a feature on Unix only.
Modules§
- backend
- Physical implementations of the Urushi terminal contracts.
Structs§
- Control
String - Printable ASCII payload carried by an ECMA-48 control string.
- Hyperlink
Parameter - One OSC 8 hyperlink parameter.
- Invalid
Control String - The location of a non-printable-ASCII byte rejected from a control-string payload.
- Invalid
Terminal Text - The location of a control character rejected from terminal text.
- KeyEvent
- One normalized key event.
- KeyEvent
State - Additional state reported with an enhanced keyboard event.
- Keyboard
Enhancement Flags - Extra information requested from terminals implementing an enhanced keyboard protocol.
- Modifiers
- The keyboard modifiers held for one input event.
- Mouse
Event - One normalized mouse event at a zero-based cell position.
- Pixel
Size - Position
- Session
Error - A session-entry failure and the first restoration failure, if any.
- Session
Options - Terminal modes acquired by a session.
- Terminal
Background - An RGB background color reported by a terminal.
- Terminal
Capabilities - Rendering features positively confirmed by a terminal query or supplied by an explicitly configured backend.
- Terminal
Graphics Protocols - A set of terminal graphics protocols supported by a terminal.
- Terminal
Hyperlink - A hyperlink attached to subsequently printed text.
- Terminal
Info - Information observed from one terminal output handle.
- Terminal
Session - A guard for every terminal state successfully acquired during entry.
- Terminal
Size - The visible dimensions of a terminal in character cells.
- Terminal
Style - The complete physical text style applied to terminal output.
- Terminal
Text - Printable terminal text containing no control characters.
- Text
Attribute Iter - Iterator over the attributes present in a
TextAttributesvalue. - Text
Attributes - A set of terminal text attributes with no duplicates or ordering.
- Underline
- An underline and its optional color independent of the foreground.
- Underline
Styles - A set of underline shapes supported by a terminal.
- Window
Size - Character-cell dimensions and optional pixel geometry for a terminal window.
Enums§
- Clear
Region - A logical region of the terminal buffer to clear.
- Color
- A color addressable by terminal text commands.
- Color
Level - The color fidelity a terminal can display.
- Command
- One semantic terminal control or text-output operation.
- Cursor
Appearance - The cursor appearance requested from the terminal.
- Cursor
Move - A cursor movement expressed independently of an escape-sequence API.
- Event
- One event read from an interactive terminal.
- Focus
Change - KeyCode
- A backend-independent terminal key.
- KeyKind
- The transition represented by a key event.
- Media
KeyCode - Modifier
KeyCode - Mouse
Button - Mouse
Kind - A normalized mouse action.
- Terminal
Detection - Whether one output handle is attached to a terminal.
- Terminal
Graphics Protocol - A terminal graphics protocol that can display raster images.
- Text
Attribute - One independently selectable terminal text attribute.
- Underline
Style - The shape of an underline drawn by the terminal.
Traits§
- Command
Writer - Writes backend-independent terminal commands in caller-selected order.
- Event
Source - Blocking and non-blocking reads from one normalized event source.
- Keyboard
Enhancement Query - Detects whether enhanced keyboard protocol negotiation is available.
- RawMode
Control - Process-side terminal modes that cannot be expressed as terminal commands.
- Terminal
Backend - A complete interactive terminal connection.
- Terminal
Output - A terminal output sink whose queued operations can be made visible.
- Terminal
Query - Synchronous inspection of terminal state.