reproto-core 0.3.36

Rethinking Protocol Generators
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Data Models for fields

use errors::Result;
use {Diagnostics, Flavor, FlavorField, Translate, Translator};

#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
#[serde(bound = "F::Type: ::serde::Serialize")]
pub struct RpField<F: 'static>
where
    F: Flavor,
{
    /// Is the field required.
    pub required: bool,
    /// Mangled identifier, taking target-specific keywords into account.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub safe_ident: Option<String>,
    /// Original identifier used to specify the field.
    pub ident: String,
    /// Field comments.
    pub comment: Vec<String>,
    #[serde(rename = "type")]
    pub ty: F::Type,
    /// Alias of field in JSON.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub field_as: Option<String>,
}

impl<F: 'static> FlavorField for RpField<F>
where
    F: Flavor,
{
    fn is_discriminating(&self) -> bool {
        self.required
    }
}

impl<F: 'static> RpField<F>
where
    F: Flavor,
{
    pub fn new<S: AsRef<str>>(ident: S, ty: F::Type) -> Self {
        RpField {
            required: true,
            safe_ident: None,
            ident: ident.as_ref().to_string(),
            comment: Vec::new(),
            ty: ty,
            field_as: None,
        }
    }

    pub fn is_optional(&self) -> bool {
        !self.required
    }

    pub fn is_required(&self) -> bool {
        self.required
    }

    /// Get the keyword-safe identifier.
    ///
    /// This will be the identifier escaped to avoid any target-language keywords.
    pub fn safe_ident(&self) -> &str {
        self.safe_ident.as_ref().unwrap_or(&self.ident)
    }

    /// Change the safe identifier.
    pub fn with_safe_ident<S: AsRef<str>>(self, safe_ident: S) -> RpField<F> {
        Self {
            safe_ident: Some(safe_ident.as_ref().to_string()),
            ..self
        }
    }

    /// Get the original identifier of the field.
    pub fn ident(&self) -> &str {
        &self.ident
    }

    /// Get the JSON name of the field, if it differs from `ident`.
    ///
    /// TODO: Return `Option`, currently returns ident. This is a better indication whether
    /// 'renaming' should occur.
    pub fn name(&self) -> &str {
        self.field_as.as_ref().unwrap_or(&self.ident)
    }

    /// Get the type of the field.
    pub fn ty(&self) -> &F::Type {
        &self.ty
    }

    pub fn display(&self) -> String {
        self.name().to_owned()
    }
}

impl<F: 'static, T> Translate<T> for RpField<F>
where
    F: Flavor,
    T: Translator<Source = F>,
{
    type Source = F;
    type Out = RpField<T::Target>;

    /// Translate into different flavor.
    fn translate(self, diag: &mut Diagnostics, translator: &T) -> Result<RpField<T::Target>> {
        Ok(RpField {
            required: self.required,
            safe_ident: self.safe_ident,
            ident: self.ident,
            comment: self.comment,
            ty: translator.translate_type(diag, self.ty)?,
            field_as: self.field_as,
        })
    }
}