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

//! # Escaping mode
//!
//! The one place the codec consults the card version: value escaping (RFC 6350
//! 3.4) differs between vCard 2.1 and the later versions, and parameter
//! encoding (RFC 6868) exists only from 4.0.
//!
//! A value node and a parameter node each carry a [`VcardEscaper`] telling the
//! sibling [`escape`](crate::tree::codec::escape) and
//! [`unescape`](crate::tree::codec::unescape) codecs which rules to apply.

use crate::version::VcardVersion;

/// The escaping rules to apply, selected by the card version.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum VcardEscaper {
    /// vCard 2.1 (versitcard): only `;` is escaped (`\;`) in a value; a
    /// backslash before anything else is literal.
    V2_1,
    /// vCard 3.0 (RFC 2426): the value escapes `\\`, `\,`, `\;` and `\n`.
    V3_0,
    /// vCard 4.0 (RFC 6350): the same value escapes as 3.0, plus the RFC 6868
    /// parameter value encoding.
    #[default]
    V4_0,
}

impl VcardEscaper {
    /// The escaping rules a card of `version` uses.
    pub fn for_version(version: VcardVersion) -> Self {
        match version {
            VcardVersion::V2_1 => Self::V2_1,
            VcardVersion::V3_0 => Self::V3_0,
            VcardVersion::V4_0 => Self::V4_0,
        }
    }

    /// The escaping rules for a raw `VERSION` wire string (e.g. `"2.1"`).
    pub fn for_version_str(version: &str) -> Self {
        match version.parse() {
            Ok(version) => Self::for_version(version),
            Err(_) => Self::default(),
        }
    }

    /// Whether this version carries the RFC 6868 parameter value encoding,
    /// which updates RFC 6350 and so reaches vCard 4.0 alone: 2.1 and 3.0
    /// predate it, and a caret in one of their parameters is a literal caret.
    pub fn has_param_encoding(self) -> bool {
        matches!(self, Self::V4_0)
    }
}