Struct widgetui::app::App

pub struct App { /* private fields */ }

The powerhouse of tui-helper, runs all defined widgets for you at a set framerate

Implementations

impl App

pub fn new(clock: u64) -> Result<Self, Box<dyn Error>>

Create a new app with the given clock time (in ms)

Examples found in repository

examples/minimal.rs (line 17)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?.with_widget(widget).run()
}

examples/custom_chunk.rs (line 41)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_generator)
        .with_widget(render)
        .run()
}

examples/custom_state.rs (line 38)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .with_state(CustomState { state: 0 })
        .with_widget(handle_state)
        .handle_panics()
        .run()
}

examples/message.rs (line 47)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_builder)
        .with_widget(my_widget)
        .with_set(Message)
        .run()
}

pub fn handle_panics(self) -> Self

Running this will ensure that any panic that happens, this will catch And prevent your terminal from messing up.

Examples found in repository

examples/custom_chunk.rs (line 42)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_generator)
        .with_widget(render)
        .run()
}

examples/custom_state.rs (line 41)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .with_state(CustomState { state: 0 })
        .with_widget(handle_state)
        .handle_panics()
        .run()
}

examples/message.rs (line 48)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_builder)
        .with_widget(my_widget)
        .with_set(Message)
        .run()
}

pub fn with_widget<I, W: Widget + 'static>( self, widget: impl IntoWidget<I, Widget = W> + 'static ) -> Self

Add a widget to the system

Examples found in repository

examples/minimal.rs (line 17)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?.with_widget(widget).run()
}

examples/custom_chunk.rs (line 43)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_generator)
        .with_widget(render)
        .run()
}

examples/custom_state.rs (line 40)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .with_state(CustomState { state: 0 })
        .with_widget(handle_state)
        .handle_panics()
        .run()
}

examples/message.rs (line 49)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_builder)
        .with_widget(my_widget)
        .with_set(Message)
        .run()
}

pub fn with_state<S: Any>(self, state: S) -> Self

Add a state to the system

Examples found in repository

examples/custom_state.rs (line 39)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .with_state(CustomState { state: 0 })
        .with_widget(handle_state)
        .handle_panics()
        .run()
}

pub fn with_set(self, set: impl Set) -> Self

Add a set to the system

Examples found in repository

examples/message.rs (line 51)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_builder)
        .with_widget(my_widget)
        .with_set(Message)
        .run()
}

pub fn run(self) -> Result<(), Box<dyn Error>>

Run the app, returning an error if any of the functions error out.

Examples found in repository

examples/minimal.rs (line 17)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?.with_widget(widget).run()
}

examples/custom_chunk.rs (line 45)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_generator)
        .with_widget(render)
        .run()
}

examples/custom_state.rs (line 42)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .with_state(CustomState { state: 0 })
        .with_widget(handle_state)
        .handle_panics()
        .run()
}

examples/message.rs (line 52)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .with_widget(chunk_builder)
        .with_widget(my_widget)
        .with_set(Message)
        .run()
}