Library usage

The vcard-lib crate provides vCard parsing and display functionality.

Generate documentation

You'll need to have Rust installed on your system.

git clone https://github.com/conradkleinespel/kit.git && cd kit
cargo doc --package vcard-lib

Open the HTML file created by cargo doc to browse documentation.

Full documentation with private items

By default, cargo doc only renders public API items. To build the complete documentation including private fields and internal modules (useful when exploring the codebase or contributing), pass the --document-private-items flag:

cargo doc --package vcard-lib --document-private-items --open

The --open flag automatically opens the generated documentation in your browser once the build completes.

Upcoming crates.io publication

The library will soon be published on crates.io with automatic docs.rs integration. Once published, you'll be able to browse the full API documentation online and add the crate to your project with cargo add vcard-lib.

Core types

The library exposes the following main types:

• VCard — the entry point for parsing vCard data
• ContentLine — a parsed line within a vCard
• Property — the property type (e.g. FN, TEL, EMAIL)

Parsing

use vcard_lib::VCard;

let bytes = b"BEGIN:VCARD\r\nVERSION:4.0\r\nFN:Jane Doe\r\nEND:VCARD\r\n";
let result = VCard::parse(bytes, false);

The second argument controls strict RFC parsing mode.