Crate vcard4

Fast and correct vCard parser based on RFC6350.

vCards inherently contain private information so this library implements a zeroize feature (which is enabled by default) to securely zero the memory for all the data in a vCard when it is dropped.

Certain external types cannot be zeroize’d due to the restrictions on implementing external traits on external types and are therefore exempt:

• Uri
• Time / UtcOffset / OffsetDateTime
• LanguageTag (feature: language-tags)
• Mime (feature: mime)

If the mime feature is enabled the MEDIATYPE parameter is parsed to a Mime struct otherwise it is a String.

If the language-tags feature is enabled the LANG property and the LANGUAGE parameter are parsed using the language-tags crate.

Serde support can be enabled with the serde feature.

Examples

Create a new vCard:

use vcard4::VcardBuilder;
let card = VcardBuilder::new("John Doe".to_owned())
    .nickname("Johnny".to_owned())
    .finish();
print!("{}", card);

Decoding and encoding:

use anyhow::Result;
use vcard4::parse;
pub fn main() -> Result<()> {
    let input = r#"BEGIN:VCARD
VERSION:4.0
FN:John Doe
NICKNAME:Johnny
END:VCARD"#;
    let cards = parse(input)?;
    let card = cards.first().unwrap();
    let encoded = card.to_string();
    let decoded = parse(&encoded)?.remove(0);
    assert_eq!(card, &decoded);
    Ok(())
}

Iterative parsing is useful if you only need the first vCard or wish to ignore vCards that have errors (possibly during an import operation):

use anyhow::Result;
use vcard4::iter;

pub fn main() -> Result<()> {
    let input = r#"BEGIN:VCARD
VERSION:4.0
FN:John Doe
END:VCARD

BEGIN:VCARD
VERSION:4.0
FN:Jane Doe
END:VCARD"#;
    let mut it = iter(input, true);
    print!("{}", it.next().unwrap()?);
    print!("{}", it.next().unwrap()?);
    assert!(matches!(it.next(), None));
    Ok(())
}

Implementation

• The XML property is parsed and propagated but it is not validated as it is optional in the RFC.
• IANA Tokens are not implemented.
• The RFC requires a CRLF sequence for line breaks but for easier interoperability between platforms we treat the carriage return as optional.

Re-exports

pub use time;

Modules

helper

Utilities for parsing dates, times and primitive values.

parameter

Types for property parameters.

property

Types for properties.

Structs

Date

Date that serializes to and from RFC3339.

DateTime

Date and time that serializes to and from RFC3339.

Uri

URI type for the library.

Vcard

The vCard type.

VcardBuilder

Build vCard instances.

VcardIterator

Iterator for parsing vCards.

Enums

Error

Errors generated by the vCard library.

Functions

iter

Create a parser iterator.

parse

Parse a vCard string into a collection of vCards.

parse_loose

Parse a vCard string into a collection of vCards ignoring properties that generate errors.

Type Aliases

Result

Result type for the vCard library.