egui-cha 0.6.0

TEA (The Elm Architecture) framework for egui
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
85
86
87
88
89
90
91
92
93

//! Core App trait - The heart of TEA

use crate::{error::FrameworkError, sub::Sub, Cmd, ViewCtx};

/// The main application trait following TEA (The Elm Architecture)
///
/// # Type Parameters
/// - `Model`: Application state
/// - `Msg`: Message type for state updates
///
/// # Example
/// ```ignore
/// struct MyApp;
///
/// impl App for MyApp {
///     type Model = AppModel;
///     type Msg = AppMsg;
///
///     fn init() -> (Self::Model, Cmd<Self::Msg>) {
///         (AppModel::default(), Cmd::none())
///     }
///
///     fn update(model: &mut Self::Model, msg: Self::Msg) -> Cmd<Self::Msg> {
///         match msg {
///             AppMsg::Increment => model.count += 1,
///             AppMsg::Decrement => model.count -= 1,
///         }
///         Cmd::none()
///     }
///
///     fn view(model: &Self::Model, ctx: &mut ViewCtx<Self::Msg>) {
///         ctx.ui.label(format!("Count: {}", model.count));
///     }
/// }
/// ```
pub trait App: Sized + 'static {
    /// Application state
    type Model: Send + 'static;

    /// Message type for triggering state updates
    type Msg: Clone + Send + 'static;

    /// Initialize the application with initial model and optional commands
    fn init() -> (Self::Model, Cmd<Self::Msg>);

    /// Update the model based on a message, optionally returning commands
    fn update(model: &mut Self::Model, msg: Self::Msg) -> Cmd<Self::Msg>;

    /// Render the view - use `ctx.emit()` to dispatch messages
    fn view(model: &Self::Model, ctx: &mut ViewCtx<Self::Msg>);

    /// Declare subscriptions based on current model state
    ///
    /// Called each frame. The runtime manages starting/stopping
    /// subscriptions as they appear or disappear.
    ///
    /// # Example
    /// ```ignore
    /// fn subscriptions(model: &Model) -> Sub<Msg> {
    ///     if model.auto_refresh {
    ///         Sub::interval("refresh", Duration::from_secs(30), Msg::Refresh)
    ///     } else {
    ///         Sub::none()
    ///     }
    /// }
    /// ```
    fn subscriptions(_model: &Self::Model) -> Sub<Self::Msg> {
        Sub::none()
    }

    /// Handle framework errors
    ///
    /// Called when the framework encounters an internal error (task panic,
    /// runtime failure, etc.). Override this to integrate with your app's
    /// error handling.
    ///
    /// Default implementation logs to tracing and continues.
    ///
    /// # Example
    /// ```ignore
    /// fn on_framework_error(model: &mut Model, err: FrameworkError) -> Cmd<Msg> {
    ///     // Add to your error console
    ///     model.errors.push_with_level(&err.message, err.severity.into());
    ///
    ///     // Or convert to your app's error type
    ///     Cmd::msg(Msg::Error(err.format_message()))
    /// }
    /// ```
    fn on_framework_error(_model: &mut Self::Model, err: FrameworkError) -> Cmd<Self::Msg> {
        err.log();
        Cmd::none()
    }
}