zeyn 0.0.8

Rust web framework for data heavy applications, written by AI agents and reviewed by people
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

//! `Live`: nodes that refresh in place when the server notifies a topic (feature `realtime`).

use super::{layout::into_node, render_child};
use crate::render::{Render, escape};
use crate::screen::{Component, Node};
use serde_json::{Value as Json, json};

into_node!(Live);

/// Wraps nodes that refresh when [`Hub::notify`](crate::realtime::Hub::notify) names `topic`:
/// grids inside reload their current page in place; without a grid the screen is rendered again
/// in place. The topic must be declared with `Realtime::topic`, and only users with its
/// permission are subscribed.
///
/// ```
/// use zeyn::prelude::*;
/// use zeyn::ui::Live;
/// use zeyn::{Component, I18n, Render};
///
/// let live = Live::new("orders").add(Alert::info("Orders"));
/// let mut html = String::new();
/// live.render(&mut html, &Render::new("s", "en", I18n::builtin()));
/// assert!(html.starts_with(r#"<div class="z-live" data-zeyn-live="orders">"#));
/// ```
pub struct Live {
    topic: &'static str,
    nodes: Vec<Node>,
}

impl Live {
    pub fn new(topic: &'static str) -> Self {
        Live {
            topic,
            nodes: Vec::new(),
        }
    }

    #[allow(
        clippy::should_implement_trait,
        reason = "a builder method that appends a child component; it is not arithmetic and `add` is the public name"
    )]
    pub fn add(mut self, node: impl Into<Node>) -> Self {
        self.nodes.push(node.into());
        self
    }
}

impl Component for Live {
    fn render(&self, out: &mut String, r: &Render) {
        out.push_str(&format!(
            r#"<div class="z-live" data-zeyn-live="{}">"#,
            escape(self.topic)
        ));
        for (i, node) in self.nodes.iter().enumerate() {
            render_child(out, r, i, node);
        }
        out.push_str("</div>");
    }

    fn schema(&self) -> Json {
        json!({ "type": "live", "topic": self.topic, "nodes": self.nodes.iter().map(Node::schema).collect::<Vec<_>>() })
    }

    fn children(&self) -> &[Node] {
        &self.nodes
    }
}