Struct microformats::types::Item

pub struct Item {
    pub type: Vec<Class>,
    pub id: ThreadSafeProperty<Option<String>>,
    pub value: ThreadSafeProperty<Option<ValueKind>>,
    /* private fields */
}

Represents the structured form of an ‘object’ in Microformats.

Fields

type: Vec<Class>

id: ThreadSafeProperty<Option<String>>

The ID string of this item, if any is resolved.

value: ThreadSafeProperty<Option<ValueKind>>

Represents the precise value of this item (if it’s defined as a property to another).

Implementations

impl Item

pub fn parent(&self) -> ParentRelationship

Provides the parent item of this item.

pub fn properties(&self) -> HashMap<String, Vec<PropertyValue>>

Provides a copy of the properties.

pub fn into_dangling(&self) -> Self

Returns this Item without a reference to the document.

pub fn new(parent: ParentRelationship, types: Vec<Class>) -> Self

Creates a new item with the provided ItemParent as its parent.

pub fn append_child(&mut self, item: &Self)

Adds a Item to this Item as a child.

pub fn is_empty(&self) -> bool

Determines if this item is undefined - an empty one.

pub fn remove_child(&mut self, problem_child: &Self)

pub fn remove_whole_property(&mut self, property_name: &str)

pub fn content(&self) -> Option<Vec<PropertyValue>>

pub fn append_property( &mut self, property_name: &str, property_value: PropertyValue )

pub fn has_nested_microformats(&self) -> bool

Checks if this item has any properties with a nested item.

pub fn children(&self) -> Vec<Item>

Obtains a list of the immediate children.

pub fn nested_children(&self) -> Vec<Item>

pub fn has_id(&self, id: &str) -> Option<Item>

pub fn has_url(&self, url: &Url) -> Option<PropertyValue>

pub fn set_parent(&mut self, property_relationship: ParentRelationship)

pub fn properties_with_matching_value( &self, property_value: PropertyValue ) -> Vec<String>

pub fn concatenate_times(&mut self)

Resolve full date time values for those missing them. This is an implementation of https://microformats.org/wiki/value-class-pattern#microformats2_parsers_implied_date.

pub fn get_property(&self, arg: &str) -> Option<Vec<PropertyValue>>

Obtains a list of values for a property.

pub fn set_id(&mut self, id_value: Option<String>)

pub fn set_value(&mut self, value: Option<ValueKind>)

pub fn value(&self) -> Option<ValueKind>

pub fn id(&self) -> Option<String>

pub fn properties_mut(&self) -> RefMut<'_, HashMap<String, Vec<PropertyValue>>>

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Item

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Item> for PropertyValue

fn from(item: Item) -> Self

Converts to this type from the input type.

impl IntoIterator for Item

type Item = Item

The type of the elements being iterated over.

type IntoIter = IntoIter<<Item as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Item

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Item

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

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

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

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

impl PartialOrd for Item

fn partial_cmp(&self, other: &Self) -> 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 Serialize for Item

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Map<String, Value>> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Map<String, Value>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<Value> for Item

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Value, Self::Error>

Performs the conversion.

impl Eq for Item

impl StructuralEq for Item

impl StructuralPartialEq for Item