rocket-include-tera 0.6.0

This is a crate which provides macros `tera_resources_initialize!` and `tera_response!` to statically include Tera files from your Rust project and make them be the HTTP response sources quickly.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::sync::{Arc, Mutex, PoisonError};

use lru_time_cache::LruCache;
use serde::Serialize;
use tera::{Context, Tera};

use super::TeraResponse;
use crate::{EntityTag, EtagIfNoneMatch, functions::compute_data_etag};

#[allow(clippy::type_complexity)]
/// To monitor the state of Tera.
#[derive(Educe)]
#[educe(Debug)]
pub struct TeraContextManager {
    pub tera:    Tera,
    #[educe(Debug(ignore))]
    cache_table: Mutex<LruCache<String, (Arc<str>, Arc<EntityTag<'static>>)>>,
}

impl TeraContextManager {
    #[inline]
    pub(crate) fn new(tera: Tera, cache_capacity: usize) -> TeraContextManager {
        TeraContextManager {
            tera,
            cache_table: Mutex::new(LruCache::with_capacity(cache_capacity)),
        }
    }

    /// Build a `TeraResponse`.
    #[inline]
    pub fn build<S: AsRef<str>, V: Serialize>(
        &self,
        etag_if_none_match: &EtagIfNoneMatch<'_>,
        minify: bool,
        name: S,
        context: V,
    ) -> TeraResponse {
        self.tera
            .render(name.as_ref(), &Context::from_serialize(&context).unwrap())
            .map(|html| {
                let etag = compute_data_etag(html.as_bytes());

                if etag_if_none_match.weak_eq(&etag) {
                    TeraResponse::not_modified()
                } else {
                    let html = if minify { html_minifier::minify(html).unwrap() } else { html };

                    TeraResponse::build_not_cache(html, etag)
                }
            })
            .unwrap()
    }

    /// Build a `TeraResponse`.
    #[inline]
    pub fn build_from_cache<K: AsRef<str>>(
        &self,
        etag_if_none_match: &EtagIfNoneMatch<'_>,
        key: K,
    ) -> Option<TeraResponse> {
        self.cache_table.lock().unwrap_or_else(PoisonError::into_inner).get(key.as_ref()).map(
            |(html, etag)| {
                if etag_if_none_match.weak_eq(etag) {
                    TeraResponse::not_modified()
                } else {
                    TeraResponse::build_cache(html.clone(), etag.clone())
                }
            },
        )
    }

    /// Render a template.
    #[inline]
    pub fn render<S: AsRef<str>, V: Serialize>(&self, name: S, context: V) -> String {
        self.tera.render(name.as_ref(), &Context::from_serialize(&context).unwrap()).unwrap()
    }

    /// Clear cache.
    #[inline]
    pub fn clear_cache(&self) {
        self.cache_table.lock().unwrap_or_else(PoisonError::into_inner).clear();
    }

    /// Check if a cache key exists.
    #[inline]
    pub fn contains_key<S: AsRef<str>>(&self, key: S) -> bool {
        // `contains_key` is used instead of `get` because merely asking about a key should not make it the most recently used one.
        self.cache_table.lock().unwrap_or_else(PoisonError::into_inner).contains_key(key.as_ref())
    }

    /// Get the cache by a specific key.
    #[inline]
    pub fn get<S: AsRef<str>>(&self, key: S) -> Option<(Arc<str>, Arc<EntityTag<'static>>)> {
        self.cache_table
            .lock()
            .unwrap_or_else(PoisonError::into_inner)
            .get(key.as_ref())
            .map(|(html, etag)| (html.clone(), etag.clone()))
    }

    /// Insert a cache.
    #[inline]
    pub fn insert<S: Into<String>>(
        &self,
        key: S,
        cache: (Arc<str>, Arc<EntityTag<'static>>),
    ) -> Option<(Arc<str>, Arc<EntityTag<'static>>)> {
        self.cache_table.lock().unwrap_or_else(PoisonError::into_inner).insert(key.into(), cache)
    }
}