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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
use crate::dom::CustomElement;
use crate::dom::{Component, Container};
use crate::vdom::Node;
use crate::dom::Cmd;
/// An Application is the root component of your program.
/// Everything that happens in your application is done here.
///
pub trait Application<MSG>
where
MSG: 'static,
{
/// The application can implement this method where it can modify its initial state.
/// This method is called right after the program is mounted into the DOM.
fn init(&mut self) -> Cmd<Self, MSG>
where
Self: Sized + 'static,
{
Cmd::none()
}
/// Update the component with a message.
/// The update function returns a Cmd, which can be executed by the runtime.
///
/// Called each time an action is triggered from the view
fn update(&mut self, _msg: MSG) -> Cmd<Self, MSG>
where
Self: Sized + 'static;
/// Returns a node on how the component is presented.
fn view(&self) -> Node<MSG>;
/// optionally an Application can specify its own css style
fn style(&self) -> String;
/// This is called after dispatching and updating the dom for the component
/// This is for diagnostic and performance measurement purposes.
///
/// Warning: DO NOT use for anything else other than the intended purpose
fn measurements(&self, measurements: Measurements) -> Cmd<Self, MSG>
where
Self: Sized + 'static,
{
log::debug!("Measurements: {:#?}", measurements);
Cmd::none().no_render()
}
}
/// Contains the time it took for the last app update call for the component
/// TODO: Maybe rename to Diagnostics
#[derive(Clone, Debug, PartialEq)]
pub struct Measurements {
/// The application can name this measurement to determine where this measurement is coming
/// from.
pub name: Option<String>,
/// The number of DOM nodes in this Component
pub node_count: usize,
/// Time it took for the Component to build it's view
pub build_view_took: f64,
/// Total number of patches applied on this update loop
pub total_patches: usize,
/// Time it took for the patching the DOM.
pub dom_update_took: f64,
/// Total time it took for the component dispatch
pub total_time: f64,
}
/// Auto implementation of Application trait for Component that
/// has no external MSG
/// but only if that Component is intended to be a CustomElement
impl<COMP, MSG> Application<MSG> for COMP
where
COMP: Component<MSG, ()> + 'static,
COMP: CustomElement<MSG>,
MSG: 'static,
{
fn update(&mut self, msg: MSG) -> Cmd<Self, MSG> {
let effects = <Self as crate::Component<MSG, ()>>::update(self, msg);
Cmd::from(effects)
}
fn view(&self) -> Node<MSG> {
<Self as crate::Component<MSG, ()>>::view(self)
}
fn style(&self) -> String {
<Self as crate::Component<MSG, ()>>::style(self)
}
}
/// Auto implementation of Component trait for Container,
/// which in turn creates an Auto implementation trait for of Application for Container
/// but only if that Container is intended to be a CustomElement
impl<CONT, MSG> Component<MSG, ()> for CONT
where
CONT: Container<MSG, ()>,
CONT: CustomElement<MSG>,
MSG: 'static,
{
fn update(&mut self, msg: MSG) -> crate::Effects<MSG, ()> {
<Self as crate::Container<MSG, ()>>::update(self, msg)
}
fn view(&self) -> Node<MSG> {
// converting the component to container loses ability
// for the container to contain children components
<Self as crate::Container<MSG, ()>>::view(self, [])
}
fn style(&self) -> String {
<Self as crate::Container<MSG, ()>>::style(self)
}
}