sofie-engine 0.4.0

Screens: the template parser and renderer, and the component catalog.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

#[cfg(feature = "gates")]
mod gates;
#[cfg(all(feature = "gates", feature = "parse"))]
mod parse;
#[cfg(feature = "gates")]
mod withheld;

use sofie_core::Show;

#[cfg(feature = "gates")]
pub use self::gates::Gates;
#[cfg(feature = "gates")]
pub(crate) use self::gates::{Asks, Gate, GatesRef};
#[cfg(all(feature = "gates", feature = "parse"))]
pub(crate) use self::parse::parse_gate;
#[cfg(feature = "gates")]
pub(crate) use self::withheld::GatedPaths;
#[cfg(feature = "gates")]
pub use self::withheld::Withheld;
#[cfg(all(feature = "gates", feature = "analysis"))]
pub use self::withheld::{Withholdable, withholdable};
use crate::language::Language;
use crate::template::{mark_out_of_band, render_part, render_whole};
use crate::{RenderError, Submitted, Template, TemplateError};

/// [`Template`]'s own renders are for no request: plain language, nothing gated shown.
#[derive(Clone, Copy)]
pub struct Rendering<'t> {
    template: &'t Template,
    language: Language<'t>,
    keyed_forms: bool,
}

impl<'t> Rendering<'t> {
    #[must_use]
    pub fn new(template: &'t Template) -> Self {
        Self {
            template,
            language: Language::plain(),
            keyed_forms: false,
        }
    }

    /// Each form carries a fresh idempotency key, so one posted without JavaScript reaches an
    /// `.idempotent()` route as engine.js's header would.
    #[must_use]
    pub fn keyed_forms(mut self) -> Self {
        self.keyed_forms = true;
        self
    }

    #[cfg(feature = "i18n")]
    #[must_use]
    pub fn language(mut self, language: crate::Language<'t>) -> Self {
        #[cfg(feature = "gates")]
        let language = language.with_gates(self.language.gates());
        self.language = language;
        self
    }

    #[cfg(feature = "gates")]
    #[must_use]
    pub fn gates(mut self, gates: &'t dyn Gates) -> Self {
        self.language = self.language.with_gates(Some(gates));
        self
    }

    /// The data paths bound only inside parts this viewer may not see, which JSON and a client
    /// area's envelope leave out as the page does.
    #[cfg(feature = "gates")]
    #[must_use]
    pub fn withheld(&self) -> Withheld<'t> {
        self.template
            .precomputed
            .gated_paths
            .withheld(self.language.gates())
    }

    /// What a client area's screen is given beside its data, in this rendering's language and
    /// for its viewer.
    #[cfg(feature = "clients")]
    #[must_use]
    pub fn client_view(&self) -> crate::ClientView {
        crate::client_view::client_parts(self.template).view(self.language)
    }

    /// A listing's refused filters in a client area's data, written in this rendering's language.
    #[cfg(all(feature = "clients", feature = "listing"))]
    pub fn translate_listing_errors(&self, data: &mut serde_json::Value) {
        crate::client_view::client_parts(self.template)
            .translate_listing_errors(data, self.language);
    }

    pub fn render(&self, data: &(impl Show + ?Sized)) -> Result<String, TemplateError> {
        render_whole(
            self.template,
            data.show(),
            None,
            self.language,
            self.keyed_forms,
        )
    }

    pub fn render_submitted(
        &self,
        data: &(impl Show + ?Sized),
        submitted: &Submitted<'_>,
    ) -> Result<String, TemplateError> {
        render_whole(
            self.template,
            data.show(),
            Some(submitted),
            self.language,
            self.keyed_forms,
        )
    }

    pub fn render_fragment(
        &self,
        data: &(impl Show + ?Sized),
        id: &str,
    ) -> Result<String, RenderError> {
        render_part(
            self.template,
            data.show(),
            id,
            self.language,
            self.keyed_forms,
        )
    }

    pub fn render_out_of_band(
        &self,
        data: &(impl Show + ?Sized),
        id: &str,
    ) -> Result<String, RenderError> {
        self.render_fragment(data, id).map(mark_out_of_band)
    }
}