vcard-rs 0.4.0

vCard parser, validator, editor, merger and builder 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

//! # GENDER
//!
//! The `GENDER` property, pairing a sex code with a free-text identity.
//!
//! See RFC 6350 6.2.7.

use alloc::string::{String, ToString};

use crate::{
    param::VcardParamKind,
    prop::{VcardPropKind, cardinality::VcardPropCardinality, spec::VcardPropSpec},
    value::{VcardValue, VcardValueKind},
    version::VcardVersion,
};

/// The `GENDER` property marker.
pub struct GENDER;

impl VcardPropSpec for GENDER {
    const KIND: VcardPropKind = VcardPropKind::Gender;

    fn allowed_versions() -> &'static [VcardVersion] {
        &[VcardVersion::V4_0]
    }

    fn cardinality(_version: VcardVersion) -> VcardPropCardinality {
        VcardPropCardinality::AtMostOne
    }

    fn allowed_values(_version: VcardVersion) -> &'static [VcardValueKind] {
        &[VcardValueKind::Gender]
    }

    fn allowed_params(_version: VcardVersion) -> &'static [VcardParamKind] {
        &[VcardParamKind::Value]
    }

    /// RFC 6350 6.2.7 closes the sex component:
    ///
    /// ```abnf
    /// sex = "" / "M" / "F" / "O" / "N" / "U"
    /// ```
    ///
    /// No `iana-token` and no `x-name`, which is what makes it different
    /// from every other vocabulary in the format. Anything else belongs in
    /// the identity component, which is free text: the RFC's own examples
    /// are `GENDER:O;intersex` and `GENDER:;it's complicated`.
    fn invalid_value(value: &VcardValue<'_>, _version: VcardVersion) -> Option<String> {
        let VcardValue::Gender(gender) = value else {
            return None;
        };

        let sex = gender.sex.as_ref();

        SEXES
            .iter()
            .all(|allowed| !sex.eq_ignore_ascii_case(allowed))
            .then(|| sex.to_string())
    }
}

/// The sex codes RFC 6350 6.2.7 defines, the empty one included.
const SEXES: &[&str] = &["", "M", "F", "O", "N", "U"];