shelly-liveview 0.6.0

Core runtime primitives for Shelly LiveView.
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

use crate::{Context, Html, LiveView};
use std::fmt;

/// Stable server-owned identifier for a nested LiveView instance.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NestedLiveViewId(String);

impl NestedLiveViewId {
    pub fn new(id: impl Into<String>) -> Self {
        Self(id.into())
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for NestedLiveViewId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.0)
    }
}

impl From<&str> for NestedLiveViewId {
    fn from(value: &str) -> Self {
        Self::new(value)
    }
}

impl From<String> for NestedLiveViewId {
    fn from(value: String) -> Self {
        Self::new(value)
    }
}

/// Runtime lifecycle state for one nested LiveView.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NestedLiveViewState {
    /// Child is mounted and accepts scoped events.
    Mounted,
    /// Child keeps server state but does not accept browser events.
    Suspended,
    /// Child has terminated and no longer accepts events or renders.
    Terminated,
}

/// Public snapshot of one nested LiveView runtime boundary.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NestedLiveViewSnapshot {
    pub id: NestedLiveViewId,
    pub target: String,
    pub state: NestedLiveViewState,
    pub route_path: String,
}

pub(crate) struct NestedLiveViewInstance {
    pub(crate) view: Box<dyn LiveView>,
    pub(crate) ctx: Context,
    pub(crate) state: NestedLiveViewState,
    pub(crate) last_render: Option<Html>,
}

impl NestedLiveViewInstance {
    pub(crate) fn snapshot(&self, id: NestedLiveViewId) -> NestedLiveViewSnapshot {
        NestedLiveViewSnapshot {
            id,
            target: self.ctx.target_dom_id().to_string(),
            state: self.state,
            route_path: self.ctx.route_path().to_string(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{NestedLiveViewId, NestedLiveViewState};

    #[test]
    fn nested_live_view_id_round_trips() {
        let id = NestedLiveViewId::new("sidebar");
        assert_eq!(id.as_str(), "sidebar");
        assert_eq!(id.to_string(), "sidebar");
        assert_eq!(NestedLiveViewId::from("sidebar"), id);
    }

    #[test]
    fn nested_live_view_state_is_copyable() {
        let state = NestedLiveViewState::Mounted;
        assert_eq!(state, NestedLiveViewState::Mounted);
    }
}