Struct widgetui::app::App

pub struct App { /* private fields */ }

The powerhouse of widgetui, runs all defined widgets for you

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/custom_set.rs (line 46)

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

examples/minimal.rs (line 19)

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

examples/custom_chunk.rs (line 42)

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

examples/message.rs (line 43)

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

examples/custom_state.rs (line 38)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .states(CustomState { state: 0 })
        .widgets(handle_state)
        .handle_panics()
        .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 43)

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

examples/message.rs (line 44)

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

examples/custom_state.rs (line 41)

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

pub fn widgets<I, T>(self, widget: impl IntoWidgetSet<I, T>) -> Self

Adds the following Widgets to the system. This will take in a tuple of widgets, or a single widget.

Examples found in repository

examples/minimal.rs (line 19)

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

examples/custom_chunk.rs (line 44)

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

examples/message.rs (line 45)

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

examples/custom_state.rs (line 40)

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

pub fn widget<W: Widget + 'static>(self, widget: W) -> Self

pub fn states<S: MultiFromStates>(self, state: S) -> Self

Add the following states to the system This will take in a state or a tuple of states.

Examples found in repository

examples/custom_state.rs (line 39)

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

pub fn sets(self, set: impl Sets) -> Self

Add a set to the system

Examples found in repository

examples/custom_set.rs (line 46)

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

examples/message.rs (line 46)

fn main() -> Result<(), Box<dyn Error>> {
    App::new(100)?
        .handle_panics()
        .widgets((chunk_builder, my_widget))
        .sets(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/custom_set.rs (line 46)

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

examples/minimal.rs (line 19)

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

examples/custom_chunk.rs (line 45)

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

examples/message.rs (line 47)

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

examples/custom_state.rs (line 42)

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