Skip to main content

Runtime

Struct Runtime 

Source
pub struct Runtime<A: App> { /* private fields */ }
Expand description

Configures and runs an application in the terminal.

Implementations§

Source§

impl<A: App> Runtime<A>

Source

pub fn new(app: A) -> Self

A runtime for app with built-in files only.

Source

pub fn theme_dir(self, dir: impl Into<PathBuf>) -> Self

Loads theme files from dir.

Source

pub fn icon_dir(self, dir: impl Into<PathBuf>) -> Self

Loads icon set files from dir.

Source

pub fn locale_dir(self, dir: impl Into<PathBuf>) -> Self

Loads locale files from dir.

Source

pub fn keymap_file(self, file: impl Into<PathBuf>) -> Self

Layers keymap file over the built-in keymap.

Source

pub fn theme(self, id: impl Into<String>) -> Self

Starts with theme id instead of the default.

Source

pub fn settings(self, settings: &Settings) -> Self

Starts with the theme, language, icon mode and reduced motion saved in settings, so the first frame already looks the way the user left it. Saved values win over Runtime::theme.

Source

pub fn run(self) -> Result<()>

Takes over the terminal and runs until the application quits. The terminal is restored on return and on panic.

§Errors

Returns I/O errors from loading asset directories or from the terminal.

Auto Trait Implementations§

§

impl<A> !RefUnwindSafe for Runtime<A>

§

impl<A> !UnwindSafe for Runtime<A>

§

impl<A> Freeze for Runtime<A>
where A: Freeze,

§

impl<A> Send for Runtime<A>
where A: Send,

§

impl<A> Sync for Runtime<A>
where A: Sync,

§

impl<A> Unpin for Runtime<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for Runtime<A>
where A: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.