winio 0.11.0

Single-threaded async GUI runtime based on compio.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use std::future::Future;

use compio_log::{error, warn};
use futures_util::StreamExt;
use winio_elm::{Component, Root, RunEvent};

use crate::{sys, sys::Runtime};

/// Root application, manages the async runtime.
pub struct App {
    runtime: Runtime,
    name: String,
}

impl App {
    /// Create [`App`] with application name.
    pub fn new(name: impl AsRef<str>) -> sys::Result<Self> {
        #[allow(unused_mut)]
        let mut runtime = Runtime::new()?;
        let name = name.as_ref().to_string();
        #[cfg(not(any(windows, target_vendor = "apple")))]
        runtime.set_app_id(&name)?;
        Ok(Self { runtime, name })
    }

    /// The application name.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Block on the future till it completes.
    ///
    /// The inner runtime might exits the inner application loop after the
    /// execution of the future.
    pub fn block_on<F: Future>(&self, future: F) -> F::Output {
        self.runtime.block_on(future)
    }

    /// Run the component till the first event is emitted. [`RunEvent`] is
    /// flattened to [`Result`].
    pub fn run<'a, T: Component>(
        &self,
        init: impl Into<T::Init<'a>>,
    ) -> Result<T::Event, T::Error> {
        self.block_on(async move {
            let mut component = Root::<T>::init(init).await?;
            let stream = component.run();
            let mut stream = std::pin::pin!(stream);
            stream
                .next()
                .await
                .expect("component exits unexpectedly")
                .flatten()
        })
    }

    /// Run the component utill [`RunEvent::Event`] is emitted. Other variants
    /// of [`RunEvent`] are ignored.
    pub fn run_until_event<'a, T: Component>(
        &self,
        init: impl Into<T::Init<'a>>,
    ) -> Result<T::Event, T::Error> {
        self.block_on(async move {
            let mut component = Root::<T>::init(init).await?;
            let stream = component.run();
            let mut stream = std::pin::pin!(stream);
            while let Some(event) = stream.next().await {
                match event {
                    RunEvent::Event(e) => return Ok(e),
                    RunEvent::UpdateErr(_e) => {
                        error!("Component update error: {_e:?}");
                    }
                    RunEvent::RenderErr(_e) => {
                        error!("Component render error: {_e:?}");
                    }
                    _ => {
                        warn!("Unrecognized event.");
                    }
                }
            }
            unreachable!("component exits unexpectedly")
        })
    }
}