How would one get the terminal display

[bogzbonny]

I'm looking at the Terminal Trait and I don't see how the user of the Terminal is supposed to get the current display of the terminal (aka the ANSI values at each position). Is this within scope?

side question (maybe should be a different issue) is there a way to artificially push events to the terminal? without it reading stdin?

[the-mikedavis]

That kind of information isn't stored. The Terminal trait and PlatformTerminal are meant to cover only the platform-specific parts of interacting with the terminal (reading from stdin, writing to stdout, getting the dimensions, etc.). There aren't any high level abstractions like a buffer or cells. That is out of scope for Termina and is better handled by a higher level library like ratatui. (Though currently there isn't a ratatui backend for Termina as far as I know.)

is there a way to artificially push events to the terminal

Do you mean so that the events would be returned from the EventStream and Terminal::poll and Terminal::read? There isn't a way to do this and I don't think it would be easy to add based on the way those functions/types work. Instead that could be handled by something in the application/library that uses Termina. For EventStream for example you could merge another stream that has arbitrary events with the select combinator or tokio::select! or similar functions/macros.

[the-mikedavis]

For a better example usage than the examples/ directory you can reference https://github.com/helix-editor/helix/blob/termina/helix-tui/src/backend/termina.rs (part of helix-editor/helix#13307). The helix-tui crate is forked from https://github.com/fdehau/tui-rs which was also forked as ratatui so if you're already familiar with ratatui that should be a good guide

[orhun]

Speaking of rats, just created a tracking issue for adding a termina backend to ratatui: ratatui/ratatui#1784