Struct vobject::component::Component

pub struct Component {
    pub name: String,
    pub props: BTreeMap<String, Vec<Property>>,
    pub subcomponents: Vec<Component>,
}

Fields

name: String

The name of the component, such as VCARD or VEVENT.

props: BTreeMap<String, Vec<Property>>

The component’s properties.

subcomponents: Vec<Component>

The component’s child- or sub-components.

Implementations

impl Component

pub fn new<N: Into<String>>(name: N) -> Component

pub fn push(&mut self, prop: Property)

Append the given property, preserve other same-named properties.

pub fn set(&mut self, prop: Property)

Set the given property, remove other same-named properties.

pub fn get_only<P: AsRef<str>>(&self, name: P) -> Option<&Property>

Retrieve one property by key. Returns None if not exactly one property was found.

pub fn get_all<P: AsRef<str>>(&self, name: P) -> &[Property]

Retrieve properties by key. Returns an empty slice if key doesn’t exist.

pub fn pop<P: AsRef<str>>(&mut self, name: P) -> Option<Property>

Remove a single property.

pub fn remove<P: AsRef<str>>(&mut self, name: P) -> Option<Vec<Property>>

Remove all properties

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a copy 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 FromStr for Component

fn from_str(s: &str) -> Result<Component>

Same as vobject::parse_component

type Err = VObjectErrorKind

The associated error which can be returned from parsing.