Struct Component

pub struct Component {
    pub name: String,
    pub parameters: HashMap<String, String>,
    pub values: Vec<Vec<String>>,
    /* private fields */
}

Available on crate feature read_write only.

A Component represents one single line of VCard. It has a name, it might have a group, and some parameters.

This is how it will look when turned into a string:

GROUP.NAME;PARAM=VAL;PARAM2=VAL2:VALUE1;VALUE2

I would like to point out that Component does not stop you doing stupid things. Please do not add ‘=’ signs to values (for the same reason you don’t do that normally.)

Fields

name: String

This is the name of the VCard property.

parameters: HashMap<String, String>

These are the parameters PARAM=VAL.

values: Vec<Vec<String>>

The values of the Component. They are an array of arrays. Major properties are separated by ; and minor properties by ,.

Implementations

impl Component

pub fn new(name: String) -> Self

Creates a component from a name.

Example

Create a FN component

use contack::read_write::Component;
assert_eq!(
    Component::new("FN".to_string()).to_string(),
    "FN:\r\n"
)

pub fn set_group(&mut self, group: Option<String>) -> bool

Sets the group to be the given value. Returns false on a group containing characters not included in [a-zA-Z0-9-], indicating the value has not been set.

pub const fn get_group(&self) -> &Option<String>

Get’s this’ group

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl Default for Component

fn default() -> Component

Returns the “default value” for a type.

impl Display for Component

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

Formats the value using the given formatter.

impl From<Address> for Component

fn from(adr: Address) -> Self

Converts to this type from the input type.

impl From<Component> for Name

fn from(comp: Component) -> Self

Converts to this type from the input type.

impl From<Component> for Org

fn from(comp: Component) -> Self

Converts to this type from the input type.

impl From<ContactInformation> for Component

fn from(ci: ContactInformation) -> Self

Converts to this type from the input type.

impl From<DateTime> for Component

fn from(dt: DateTime) -> Self

Converts to this type from the input type.

impl From<Gender> for Component

fn from(gender: Gender) -> Self

Converts to this type from the input type.

impl From<Name> for Component

Allows a name to be translated into a component.

You should never need to call this directly and should prefer turning a whole contact into a VCard.

Example

Convert a name into a contact and print it out.

use contack::Name;
use contack::read_write::component::Component;
 
let name = Name {
   given: vec!["John".to_string()],
   family: vec!["Doe".to_string()],
   ..Default::default()
};

let component: Component = name.into();

// NAME:Doe;John;;;;
println!("{}", component);

fn from(name: Name) -> Self

Converts to this type from the input type.

impl From<Org> for Component

fn from(org: Org) -> Self

Converts to this type from the input type.

impl From<Uri> for Component

fn from(uri: Uri) -> Self

Converts to this type from the input type.

impl FromStr for Component

type Err = ComponentParseError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Component

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Component> for Address

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(comp: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for ContactInformation

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(comp: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for DateTime

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(comp: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Gender

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(comp: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for Uri

type Error = FromComponentError

The type returned in the event of a conversion error.

fn try_from(comp: Component) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Component

impl StructuralPartialEq for Component