rjango 0.1.1

A full-stack Rust backend framework inspired by Django
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use crate::core::validators::{
    validate_ipv4_address, validate_ipv6_address, validate_ipv46_address,
};

use super::mixins::{FieldCacheMixin, FieldValidationMixin};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GenericIPAddressProtocol {
    Both,
    Ipv4,
    Ipv6,
}

/// A GenericIPAddressField stores IPv4 or IPv6 addresses.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct GenericIPAddressField {
    pub protocol: GenericIPAddressProtocol,
    pub unpack_ipv4: bool,
    pub max_length: usize,
}

impl Default for GenericIPAddressField {
    fn default() -> Self {
        Self {
            protocol: GenericIPAddressProtocol::Both,
            unpack_ipv4: false,
            max_length: 39,
        }
    }
}

impl GenericIPAddressField {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn with_protocol(mut self, protocol: GenericIPAddressProtocol) -> Self {
        self.protocol = protocol;
        self
    }

    #[must_use]
    pub fn unpack_ipv4(mut self) -> Self {
        self.unpack_ipv4 = true;
        self
    }

    #[must_use]
    pub fn protocol(&self) -> GenericIPAddressProtocol {
        self.protocol
    }

    #[must_use]
    pub fn db_type(&self) -> &str {
        "VARCHAR"
    }
}

impl FieldCacheMixin for GenericIPAddressField {
    fn get_cache_name(&self) -> String {
        "generic_ip_address_field".to_string()
    }

    fn is_cached(&self) -> bool {
        false
    }
}

impl FieldValidationMixin for GenericIPAddressField {
    fn validate(&self, value: &str) -> Result<(), String> {
        match self.protocol {
            GenericIPAddressProtocol::Both => {
                validate_ipv46_address(value).map_err(|error| error.message)
            }
            GenericIPAddressProtocol::Ipv4 => {
                validate_ipv4_address(value).map_err(|error| error.message)
            }
            GenericIPAddressProtocol::Ipv6 => {
                validate_ipv6_address(value).map_err(|error| error.message)
            }
        }
    }
}

/// An IPAddressField stores IPv4 addresses only.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IPAddressField {
    pub protocol: GenericIPAddressProtocol,
    pub max_length: usize,
}

impl Default for IPAddressField {
    fn default() -> Self {
        Self {
            protocol: GenericIPAddressProtocol::Ipv4,
            max_length: 15,
        }
    }
}

impl IPAddressField {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn protocol(&self) -> GenericIPAddressProtocol {
        self.protocol
    }

    #[must_use]
    pub fn max_length(&self) -> usize {
        self.max_length
    }

    #[must_use]
    pub fn db_type(&self) -> &str {
        "VARCHAR"
    }
}

impl FieldCacheMixin for IPAddressField {
    fn get_cache_name(&self) -> String {
        "ip_address_field".to_string()
    }

    fn is_cached(&self) -> bool {
        false
    }
}

impl FieldValidationMixin for IPAddressField {
    fn validate(&self, value: &str) -> Result<(), String> {
        validate_ipv4_address(value).map_err(|error| error.message)
    }
}

#[cfg(test)]
mod tests {
    use super::{GenericIPAddressField, GenericIPAddressProtocol, IPAddressField};

    #[test]
    fn generic_ip_address_field_defaults_to_both_protocols() {
        let field = GenericIPAddressField::default();

        assert_eq!(field.protocol(), GenericIPAddressProtocol::Both);
        assert_eq!(field.max_length, 39);
        assert!(!field.unpack_ipv4);
    }

    #[test]
    fn generic_ip_address_field_supports_protocol_variants() {
        let ipv6 = GenericIPAddressField::new().with_protocol(GenericIPAddressProtocol::Ipv6);
        let ipv4 = GenericIPAddressField::new().with_protocol(GenericIPAddressProtocol::Ipv4);

        assert_eq!(ipv6.protocol(), GenericIPAddressProtocol::Ipv6);
        assert_eq!(ipv4.protocol(), GenericIPAddressProtocol::Ipv4);
    }

    #[test]
    fn ip_address_field_defaults_to_ipv4() {
        let field = IPAddressField::default();

        assert_eq!(field.protocol(), GenericIPAddressProtocol::Ipv4);
        assert_eq!(field.max_length(), 15);
        assert_eq!(field.db_type(), "VARCHAR");
    }
}