sofie-engine 0.3.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

//! A part the viewer may not see is never rendered.

pub trait Gates {
    fn can(&self, permission: &str) -> bool;

    fn enabled(&self, flag: &str) -> bool;

    /// What the viewer's plan holds: a switch, or a limit or quota above zero.
    fn entitled(&self, entitlement: &str) -> bool {
        let _ = entitlement;
        false
    }
}

#[derive(Clone, Copy, Default)]
pub(crate) struct GatesRef<'a>(pub(crate) Option<&'a dyn Gates>);

impl std::fmt::Debug for GatesRef<'_> {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(if self.0.is_some() { "gated" } else { "ungated" })
    }
}

impl<'a> crate::language::Language<'a> {
    pub(crate) fn gates(self) -> Option<&'a dyn Gates> {
        self.gates.0
    }

    pub(crate) fn with_gates(mut self, gates: Option<&'a dyn Gates>) -> Self {
        self.gates = GatesRef(gates);
        self
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct Gate {
    pub(crate) asks: Asks,
    pub(crate) name: String,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Asks {
    Permission,
    Flag,
    Entitlement,
}

impl Asks {
    /// As a client's view and runtime name the kind of gate.
    #[cfg(feature = "clients")]
    pub(crate) fn name(self) -> &'static str {
        match self {
            Self::Permission => "permission",
            Self::Flag => "flag",
            Self::Entitlement => "entitlement",
        }
    }
}

impl Gate {
    /// Without gates, as when rendering for no request, nothing gated is shown.
    pub(crate) fn holds(&self, gates: Option<&dyn Gates>) -> bool {
        gates.is_some_and(|gates| match self.asks {
            Asks::Permission => gates.can(&self.name),
            Asks::Flag => gates.enabled(&self.name),
            Asks::Entitlement => gates.entitled(&self.name),
        })
    }
}