archival 0.14.0

The simplest CMS in existence
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

use std::{error::Error, fmt};

// These fields may not be used as keys in object definitions or as the names of
// objects.
pub const TEMPLATE: &str = "template";
pub const ORDER: &str = "order";
pub const OBJECTS: &str = "objects";
pub const OBJECT_NAME: &str = "object_name";
pub const PAGE: &str = "page";
pub const PAGE_NAME: &str = "page_name";

#[derive(Debug, Clone)]
pub struct ReservedFieldError {
    pub field: &'static str,
}
impl Error for ReservedFieldError {}
impl fmt::Display for ReservedFieldError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{} is a reserved field", self.field)
    }
}

pub fn reserved_field_from_str(field: &str) -> &'static str {
    match field {
        OBJECT_NAME => OBJECT_NAME,
        ORDER => ORDER,
        PAGE_NAME => PAGE_NAME,
        TEMPLATE => TEMPLATE,
        OBJECTS => OBJECTS,
        PAGE => PAGE,
        _ => panic!("{} is not a reserved field", field),
    }
}

pub fn is_reserved_field(field: &str) -> bool {
    matches!(
        field,
        OBJECT_NAME | ORDER | OBJECTS | PAGE_NAME | PAGE | TEMPLATE
    )
}