Struct prototty_unix::Context

pub struct Context<C: ColourConfig = DefaultColourConfig> { /* fields omitted */ }

An interface to a terminal for rendering Views, and getting input.

Methods

impl Context<DefaultColourConfig>

pub fn new() -> Result<Self>

Initialise a new context using the current terminal.

pub fn from_terminal(terminal: Terminal) -> Result<Self>

impl<C: ColourConfig> Context<C>

pub fn with_colour_config(colour_config: C) -> Result<Self>

pub fn from_terminal_with_colour_config(
    terminal: Terminal,
    colour_config: C
) -> Result<Self>

pub fn drain_input(&mut self) -> Result<Drain<'a, Input>>

pub fn poll_input(&mut self) -> Result<Option<Input>>

Gets an input event from the terminal if one is present, returning immediately.

pub fn wait_input(&mut self) -> Result<Input>

Gets an input event from the terminal, waiting until an event occurs.

pub fn wait_input_timeout(&mut self, timeout: Duration) -> Result<Option<Input>>

Gets an input event from the terminal, waiting until either an event occurs, or the timeout expires, in which case this method returns None.

pub fn render<V: View<T>, T>(&mut self, view: &mut V, data: T) -> Result<()>

pub fn render_at<V: View<T>, T, R: ViewTransformRgb24>(
    &mut self,
    view: &mut V,
    data: T,
    context: ViewContext<R>
) -> Result<()>

pub fn size(&self) -> Result<Size>