Struct App 

pub struct App {
    pub theme: Mutable<Arc<Theme>>,
    pub animator: Mutex<Animator>,
    /* private fields */
}

The boba application runner.

Create an App with your View implementation, configure its theme, then run it asynchronously. The terminal is managed automatically: raw mode is enabled, an alternate screen is used, and state is restored on exit.

Fields

theme: Mutable<Arc<Theme>>

The currently active Theme. Change it with App::set_theme.

animator: Mutex<Animator>

Implementations

impl App

pub fn new(v: impl View + 'static) -> Self

Construct an app wrapping view.

Examples found in repository

examples/hello_layout.rs (line 88)

fn main() {
    let rt = tokio::runtime::Builder::new_multi_thread().enable_all().build().unwrap();
    rt.block_on(async {
        App::new(HelloView).run().await.unwrap();
    });
}

examples/layout.rs (line 458)

fn main() {
    let rt = tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()
        .unwrap();
    rt.block_on(async {
        App::new(LayoutView::new()).run().await.unwrap();
    });
}

pub fn set_theme(&self, theme: Theme)

Replace the active theme at runtime.

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

Run the app until a AppEvent::Quit is emitted.

Initializes raw mode, the alternate screen, and mouse capture; restores everything on exit.

Examples found in repository

examples/hello_layout.rs (line 88)

fn main() {
    let rt = tokio::runtime::Builder::new_multi_thread().enable_all().build().unwrap();
    rt.block_on(async {
        App::new(HelloView).run().await.unwrap();
    });
}

examples/layout.rs (line 458)

fn main() {
    let rt = tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()
        .unwrap();
    rt.block_on(async {
        App::new(LayoutView::new()).run().await.unwrap();
    });
}

Methods from Deref<Target = EventTarget<AppEvent>>

pub fn set_parent(&self, _name: impl Into<String>, parent: Weak<EventTarget<T>>)

Attach a parent target so events can bubble up.

pub fn emit(&self, v: impl Into<Arc<T>> + Debug)

Examples found in repository

examples/hello_layout.rs (line 31)

    fn mount(&self, app: &EventTarget<AppEvent>) {
        let app_for_quit = app.clone();
        app.on_key(SubscriptionPriority::High, move |ev, key| {
            if key.code == KeyCode::Char('q') {
                ev.cancel();
                app_for_quit.emit(AppEvent::Quit);
            }
        })
        .forget();
    }

examples/layout.rs (line 399)

    fn mount(&self, app: &EventTarget<AppEvent>) {
        let app_for_quit = app.clone();
        app.on_key(SubscriptionPriority::High, move |ev, key| {
            if key.code == KeyCode::Char('q') {
                ev.cancel();
                app_for_quit.emit(AppEvent::Quit);
            }
        })
        .forget();
    }

pub fn emit_bubbling(&self, v: impl Into<Arc<T>> + Debug)

Emit and bubble up the parent chain.

pub fn on( &self, priority: SubscriptionPriority, handler: impl Fn(Arc<Cancellable<T>>) + Send + Sync + 'static, ) -> SubscriptionHandle<T>

pub fn as_stream(&self, p: SubscriptionPriority) -> EventStream<T>

where T: Send + Sync + 'static,

pub fn on_key( &self, priority: SubscriptionPriority, handler: impl Fn(Arc<Cancellable<AppEvent>>, KeyEvent) + Send + Sync + 'static, ) -> SubscriptionHandle<AppEvent>

Subscribe only to AppEvent::KeyEvent payloads.

The handler receives the original event (so it can call Cancellable::cancel) plus the extracted KeyEvent.

Examples found in repository

examples/hello_layout.rs (lines 28-33)

    fn mount(&self, app: &EventTarget<AppEvent>) {
        let app_for_quit = app.clone();
        app.on_key(SubscriptionPriority::High, move |ev, key| {
            if key.code == KeyCode::Char('q') {
                ev.cancel();
                app_for_quit.emit(AppEvent::Quit);
            }
        })
        .forget();
    }

examples/layout.rs (lines 396-401)

    fn mount(&self, app: &EventTarget<AppEvent>) {
        let app_for_quit = app.clone();
        app.on_key(SubscriptionPriority::High, move |ev, key| {
            if key.code == KeyCode::Char('q') {
                ev.cancel();
                app_for_quit.emit(AppEvent::Quit);
            }
        })
        .forget();
    }

Trait Implementations

impl Deref for App

type Target = EventTarget<AppEvent>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.