anaso_site_api_models 0.0.4

API models for Ana.so
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

use std::sync::Arc;

use serde::{Deserialize, Serialize};
use serde_with::{serde_as, DefaultOnError, VecSkipError};

use crate::stela::{Hero, Sidebar, SocialData, VisualSection};

/// An entire page.
#[serde_as]
#[derive(Debug, Deserialize, Serialize)]
pub struct Page {
    /// The title of the page.
    #[serde_as(as = "DefaultOnError")]
    pub title: Option<String>,
    /// What language is the page itself in.
    ///
    /// Individual sections can still have their own languages.
    ///
    /// This is an `ISO-639` locale code, such as `en`, `eo`, `es`, `fr`.
    #[serde_as(as = "DefaultOnError")]
    pub lang: Option<String>,
    /// Info for the meta tags.
    #[serde_as(as = "DefaultOnError")]
    pub social: Option<Arc<SocialData>>,
    /// How to display things on screen.
    #[serde_as(as = "DefaultOnError")]
    pub layout: Option<PageLayout>,
    /// Display something fancy at the top of the page.
    #[serde_as(as = "DefaultOnError")]
    pub hero: Option<Arc<Hero>>,
    /// Mini sections on the side of the screen.
    #[serde_as(as = "DefaultOnError")]
    pub sidebar: Option<Arc<Sidebar>>,
    /// Individual sections of the page.
    #[serde_as(as = "VecSkipError<_>")]
    #[serde(default)]
    pub sections: Vec<VisualSection>,
}

/// How to display things on screen.
#[derive(Clone, Copy, Debug, Default, Deserialize, Serialize, PartialEq, Eq)]
pub enum PageLayout {
    /// All sections laid out vertically.
    List,
    /// Each section behind a tab.
    Tabbed,
    /// Fallback.
    #[default]
    #[serde(other)]
    Unknown,
}