arcature 0.1.0

Arcature: an opinionated full-stack Rust web framework. One package, batteries included.
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

//! [`PropSchema`]: one browser prop's type and requiredness.

use serde::{Deserialize, Serialize};

use super::contract_type::ContractType;

/// One browser prop's type and requiredness.
///
/// Constructed through [`PropsSchema`](super::PropsSchema)'s builder methods
/// rather than directly, so a prop's requiredness always matches the way it
/// was declared on the page.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PropSchema {
    required: bool,
    #[serde(rename = "type")]
    ty: ContractType,
}

impl PropSchema {
    /// A prop the page component must always receive.
    pub(super) fn required(ty: ContractType) -> Self {
        Self { required: true, ty }
    }

    /// A prop the page component may receive.
    pub(super) fn optional(ty: ContractType) -> Self {
        Self {
            required: false,
            ty,
        }
    }

    /// Whether this prop must be supplied by the page component.
    #[must_use]
    pub fn is_required(&self) -> bool {
        self.required
    }

    /// The prop's browser type.
    #[must_use]
    pub fn ty(&self) -> &ContractType {
        &self.ty
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn required_and_optional_differ_only_in_requiredness() {
        let required = PropSchema::required(ContractType::string());
        let optional = PropSchema::optional(ContractType::string());
        assert!(required.is_required());
        assert!(!optional.is_required());
        assert_eq!(required.ty(), optional.ty());
    }

    #[test]
    fn serializes_the_type_under_a_type_key() {
        let json = serde_json::to_value(PropSchema::required(ContractType::boolean())).unwrap();
        assert_eq!(json["required"], true);
        assert_eq!(json["type"]["kind"], "boolean");
    }
}