vcard-rs 0.3.0

vCard parser, validator, editor and builder library for Rust
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232

//! # ADR lens
//!
//! Reading and editing the `ADR` property in place through a cursor naming
//! its components, the seven RFC 6350 ones and the eleven RFC 9554
//! extensions.
//!
//! Like [`VcardNCursor`](crate::tree::prop::n::VcardNCursor), getters decode
//! and setters encode in place, leaving the other components byte for byte
//! intact.
//!
//! Its RFC contract sits on the marker, [`ADR`].

use alloc::{borrow::Cow, vec::Vec};

use crate::{
    prop::adr::ADR,
    tree::{
        codec::VcardCodec, line::VcardLine, param::lens::VcardParamLens, prop::lens::VcardPropLens,
    },
    value::adr::VcardAdr,
};

impl VcardPropLens for ADR {
    type Target<'v> = VcardAdr<'v>;

    type Cursor<'c, 'a>
        = VcardAdrCursor<'c, 'a>
    where
        'a: 'c;

    fn cursor<'c, 'a>(line: &'c mut VcardLine<'a>) -> VcardAdrCursor<'c, 'a> {
        VcardAdrCursor { line }
    }
}

/// A typed cursor over an ADR line, naming its seven components.
pub struct VcardAdrCursor<'c, 'a> {
    /// The borrowed content line.
    pub line: &'c mut VcardLine<'a>,
}

impl VcardAdrCursor<'_, '_> {
    /// The whole decoded value.
    pub fn get(&self) -> VcardAdr<'_> {
        VcardAdr::decode(&self.line.value)
    }

    /// The post office box (deprecated), decoded.
    pub fn po_box(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(0)
    }

    /// Set the post office box.
    pub fn set_po_box<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(0, values);
    }

    /// The extended address (deprecated), decoded.
    pub fn extended(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(1)
    }

    /// Set the extended address.
    pub fn set_extended<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(1, values);
    }

    /// The street address, decoded.
    pub fn street(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(2)
    }

    /// Set the street address.
    pub fn set_street<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(2, values);
    }

    /// The locality (city), decoded.
    pub fn locality(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(3)
    }

    /// Set the locality.
    pub fn set_locality<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(3, values);
    }

    /// The region (state or province), decoded.
    pub fn region(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(4)
    }

    /// Set the region.
    pub fn set_region<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(4, values);
    }

    /// The postal code, decoded.
    pub fn postal_code(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(5)
    }

    /// Set the postal code.
    pub fn set_postal_code<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(5, values);
    }

    /// The country name, decoded.
    pub fn country(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(6)
    }

    /// Set the country name.
    pub fn set_country<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(6, values);
    }

    /// The room (RFC 9554), decoded.
    pub fn room(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(7)
    }

    /// Set the room.
    pub fn set_room<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(7, values);
    }

    /// The apartment (RFC 9554), decoded.
    pub fn apartment(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(8)
    }

    /// Set the apartment.
    pub fn set_apartment<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(8, values);
    }

    /// The floor (RFC 9554), decoded.
    pub fn floor(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(9)
    }

    /// Set the floor.
    pub fn set_floor<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(9, values);
    }

    /// The street number (RFC 9554), decoded.
    pub fn street_number(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(10)
    }

    /// Set the street number.
    pub fn set_street_number<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(10, values);
    }

    /// The street name (RFC 9554), decoded.
    pub fn street_name(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(11)
    }

    /// Set the street name.
    pub fn set_street_name<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(11, values);
    }

    /// The building (RFC 9554), decoded.
    pub fn building(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(12)
    }

    /// Set the building.
    pub fn set_building<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(12, values);
    }

    /// The block (RFC 9554), decoded.
    pub fn block(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(13)
    }

    /// Set the block.
    pub fn set_block<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(13, values);
    }

    /// The subdistrict (RFC 9554), decoded.
    pub fn subdistrict(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(14)
    }

    /// Set the subdistrict.
    pub fn set_subdistrict<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(14, values);
    }

    /// The district (RFC 9554), decoded.
    pub fn district(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(15)
    }

    /// Set the district.
    pub fn set_district<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(15, values);
    }

    /// The landmark (RFC 9554), decoded.
    pub fn landmark(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(16)
    }

    /// Set the landmark.
    pub fn set_landmark<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(16, values);
    }

    /// The cardinal direction (RFC 9554), decoded.
    pub fn direction(&self) -> Vec<Cow<'_, str>> {
        self.line.value.decode_component_list(17)
    }

    /// Set the cardinal direction.
    pub fn set_direction<S: AsRef<str>>(&mut self, values: &[S]) {
        self.line.value.set_component(17, values);
    }

    /// The first parameter of type `P` on this line, decoded.
    pub fn param<P: VcardParamLens>(&self) -> Option<P::Target<'_>> {
        self.line.param::<P>()
    }
}