topcoat 0.8.0

A modular, batteries-included Rust web framework for server-rendered apps.
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

#[cfg(feature = "serve")]
use std::net::SocketAddr;

#[cfg(feature = "serve")]
use futures_util::SinkExt;
#[cfg(feature = "serve")]
use tokio_tungstenite::tungstenite::Message;

use crate::{
    Result,
    view::{View, component, view},
};

/// Notify the topcoat dev server that the application is ready.
///
/// Connects to the dev server's WebSocket endpoint (derived from the
/// `TOPCOAT_DEV_URL` HTTP base URL provided by `topcoat dev`) and sends a
/// ready message with the application listener address when available. Does
/// nothing if the env var is not set.
#[cfg(feature = "serve")]
pub async fn notify_ready(addr: Option<SocketAddr>) {
    let Ok(base) = std::env::var("TOPCOAT_DEV_URL") else {
        return;
    };

    let ws_url = http_to_ws(&base) + "/ws";

    let Ok((mut ws, _)) = tokio_tungstenite::connect_async(&ws_url).await else {
        eprintln!("topcoat dev: failed to connect to {ws_url}");
        return;
    };

    let text = match addr {
        Some(addr) => format!("ready {addr}"),
        None => "ready".to_owned(),
    };

    let _ = ws.send(Message::Text(text.into())).await;
    let _ = ws.close(None).await;
}

#[cfg(feature = "serve")]
fn http_to_ws(url: &str) -> String {
    if let Some(rest) = url.strip_prefix("http://") {
        format!("ws://{rest}")
    } else if let Some(rest) = url.strip_prefix("https://") {
        format!("wss://{rest}")
    } else {
        url.to_string()
    }
}

/// Inject the `topcoat dev` client script.
///
/// The script reloads the page once a new build is serving, and shows a
/// small floating status indicator while the dev server is rebuilding or
/// after a build failure. Pass `status_indicator: false` to disable the
/// indicator while keeping live reload.
///
/// Renders nothing when the app is not running under `topcoat dev`.
#[component]
pub async fn script(#[default(true)] status_indicator: bool) -> Result<impl View> {
    let src = std::env::var("TOPCOAT_DEV_URL")
        .ok()
        .map(|base| format!("{base}/dev.js"));
    // Read by dev.js; only rendered when the indicator is disabled.
    let indicator_off = (!status_indicator).then_some("false");

    Ok(view! {
        if let Some(src) = src {
            <script src=(src) data-status-indicator=(indicator_off)></script>
        }
    })
}