radicle 0.25.1

Radicle standard library
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

use indexmap::IndexSet;
use serde::{Deserialize, Serialize};

use crate::prelude::RepoId;

/// Web configuration.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(
    feature = "schemars",
    derive(schemars::JsonSchema),
    schemars(rename = "WebConfig")
)]
pub struct Config {
    /// Pinned content.
    #[serde(default, skip_serializing_if = "crate::serde_ext::is_default")]
    pub pinned: Pinned,
    /// URL pointing to an image used in the header of a node page.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "schemars", schemars(url))]
    pub banner_url: Option<String>,
    /// URL pointing to an image used as the node avatar.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "schemars", schemars(url))]
    pub avatar_url: Option<String>,
    /// Node description.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Pinned content. This can be used to pin certain content when
/// listing, e.g. pin repositories on a web client.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct Pinned {
    /// Pinned repositories.
    #[serde(default, skip_serializing_if = "crate::serde_ext::is_default")]
    #[cfg_attr(
        feature = "schemars",
        schemars(with = "std::collections::HashSet<RepoId>")
    )]
    pub repositories: IndexSet<RepoId>,
}

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

    #[test]
    fn description_only() {
        let value = serde_json::json!({
            "description": "A node description",
        });
        let _: Config = serde_json::from_value(value).unwrap();
    }

    #[test]
    fn pinned_empty() {
        let value = serde_json::json!({
            "pinned": {},
        });
        let _: Config = serde_json::from_value(value).unwrap();
    }
}