snapfire 0.4.1

High-productivity web templating library designed to accelerate development with an integrated, zero-configuration live-reload server. Provides first class integration with Tera and Actix Web.
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

use crate::core::app::{Template, TeraWeb};
use actix_web::{
  HttpRequest, HttpResponse, Responder,
  body::BoxBody,
  http::{StatusCode, header::ContentType},
  web,
  web::ServiceConfig,
};
use futures_util::stream;

pub mod dev;

impl Responder for Template {
  type Body = BoxBody;

  fn respond_to(self, _req: &HttpRequest) -> HttpResponse<Self::Body> {
    // This is a synchronous call, as required.
    let result = self.app_state.render_with_context(&self.template_name, self.context);

    // Create a single-item stream that will resolve immediately with the result.
    let body_stream = stream::once(async {
      result
        .map(|s| s.into()) // Convert String to Bytes
        .map_err(|e| {
          log::error!("Template rendering error: {:?}", e);
          // Convert our internal error into an Actix-compatible error.
          actix_web::error::ErrorInternalServerError(e)
        })
    });

    // Construct the response.
    HttpResponse::build(StatusCode::OK)
      .content_type(ContentType::html())
      .streaming(body_stream)
  }
}

// This block adds the `configure_routes` method.
// It is gated by the `devel` feature.
#[cfg(feature = "devel")]
impl TeraWeb {
  /// Configures Actix services needed by SnapFire for development.
  ///
  /// Currently, this adds the WebSocket route handler for live reloading.
  /// The route is determined by the `ws_path` set in the builder.
  pub fn configure_routes(&self, cfg: &mut ServiceConfig) {
    log::info!(
      "🔥 SnapFire devel enabled. Attaching WebSocket at {}",
      self.reloader.ws_path
    );

    let broadcaster = self.get_reloader_broadcaster();

    cfg.route(
      &self.reloader.ws_path,
      web::get().to(move |req, stream| {
        // We clone the broadcaster for each new connection.
        dev::ws::websocket_handler(req, stream, broadcaster.clone())
      }),
    );
  }
}

#[cfg(not(feature = "devel"))]
impl TeraWeb {
  /// In release builds, this is a no-op that allows user code to compile
  /// without having to add `#[cfg]` attributes.
  pub fn configure_routes(&self, _cfg: &mut ServiceConfig) {
    // Does nothing.
  }
}