Struct contack::Contact

pub struct Contact {

    pub uid: String,
    pub name: Name,
    pub nickname: Option<String>,
    pub anniversary: Option<DateTime>,
    pub bday: Option<DateTime>,
    pub photo: Option<Uri>,
    pub title: Option<String>,
    pub role: Option<String>,
    pub org: Option<Org>,
    pub logo: Option<Uri>,
    pub contact_information: Vec<ContactInformation>,
    pub gender: Option<Gender>,
    pub work_address: Option<Address>,
    pub home_address: Option<Address>,
}

A structure to store contact information.

All fields correspond (at least somewhat) to the VCard 4 specification

Fields

uid: String

The Contact’s Uid

name: Name

The Contacts Name

nickname: Option<String>

The Contact’s Nickname

anniversary: Option<DateTime>

The Contact’s Anniversary

bday: Option<DateTime>

The Contact’s Birthday

photo: Option<Uri>

The Contact’s Photo

title: Option<String>

The Contact’s Job Title

role: Option<String>

The Contact’s Job Role

org: Option<Org>

The Contact’s Organization

logo: Option<Uri>

The Contact’s Organization’s Logo

contact_information: Vec<ContactInformation>

The Contact’s contact information, emails, phones etc

gender: Option<Gender>

The contact’s sex and gender

work_address: Option<Address>

The Contact’s Work Address

home_address: Option<Address>

The Contact’s Home Address

Implementations

impl Contact

pub fn gen_uid(&mut self)

Generates a uuid for the contact’s uid.

This should be called after cloning a contact, as not to have a clashing uid which breaks the specification.

The uuid crate is used for this generation.

Example

Clone a contact and give it a new uid.

use contack::{Name, Contact};
let mut contact = contact_1.clone();
contact.gen_uid();
assert_ne!(contact.uid, "");

pub fn new(name: Name) -> Self

Creates a contact from a Name

It is required to use a name from the VCard specification, alongside a uid, which is generated automatically from the uuid crate.

Example

Create a new contact with the name “John Doe”

use contack::{Name, Contact};
let contact = Contact::new(Name {
   given: vec!["John".to_string()],
   family: vec!["Doe".to_string()],
   ..Default::default()
});

Trait Implementations

impl Clone for Contact

fn clone(&self) -> Contact

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Contact

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Contact

fn default() -> Contact

Returns the “default value” for a type.

impl From<Contact> for VCard

This is supported on crate feature read_write only.

fn from(c: Contact) -> Self

Performs the conversion.

impl PartialEq<Contact> for Contact

fn eq(&self, other: &Contact) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Contact) -> bool

This method tests for !=.

impl PartialOrd<Contact> for Contact

fn partial_cmp(&self, other: &Contact) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Contact> for SqlContact

This is supported on crate feature sql only.

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(them: Contact) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SqlContact> for Contact

This is supported on crate feature sql only.

type Error = SqlConversionError

The type returned in the event of a conversion error.

fn try_from(them: SqlContact) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<VCard> for Contact

This is supported on crate feature read_write only.

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(vcard: VCard) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Contact