Struct andiskaz::terminal::Builder

pub struct Builder { /* private fields */ }

A terminal configuration builder.

Implementations

impl Builder

pub fn new() -> Self

Initializes this configuration builder.

pub fn min_screen(self, min_screen: Vec2) -> Self

Builds the minimum screen size for the application.

pub fn frame_time(self, frame_time: Duration) -> Self

Builds the rate that the screen is updated.

pub fn event_interval(self, event_interval: Duration) -> Self

Interval waited when a poll for an event fails.

pub async fn run<F, A, T>(self, start: F) -> Result<T, Error>where F: FnOnce(Terminal) -> A + Send + 'static, A: Future<Output = T> + Send + 'static, T: Send + 'static,

Starts the application and gives it a handle to the terminal. When the given start function finishes, the application’s execution stops as well.

After that start’s future returns, terminal services such as screen handle and events handle are not guaranteed to be available. One would prefer spawning tasks that use the terminal handle by joining them, and not detaching.

Returns an AlreadyRunning error if there is already an instance of terminal services executing. In other words, one should not call this function again if another call did not finish yet, otherwise it will panic.

Beware! If the given start future returns a Result, then run will return a double Result!!

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.