Struct Attributes 

pub struct Attributes(/* private fields */);

A collection of Attribute entries associated with an element.

Implementations

impl Attributes

pub fn insert(&mut self, attribute: impl Into<Attribute>) -> Option<Attribute>

Available on crate feature write only.

Inserts the given attribute and returns the previous attribute with the same name, if any.

Examples

• Inserting a custom attribute into a detached spine entry:

let mut detached = DetachedEpubSpineEntry::new("c1");
let mut entry_mut = detached.as_mut();
let attributes = entry_mut.attributes_mut();

// Insert a custom vendor attribute
attributes.insert(("this:appearance", "omit"));

assert_eq!(Some("omit"), attributes.get_value("this:appearance"));

pub fn by_name_mut(&mut self, name: &str) -> Option<&mut Attribute>

Available on crate feature write only.

Returns the mutable Attribute with the given name if present, otherwise None.

pub fn iter_mut(&mut self) -> AttributesIterMut<'_>

Available on crate feature write only.

Returns an iterator over all mutable Attribute entries.

pub fn remove(&mut self, name: &str) -> Option<Attribute>

Available on crate feature write only.

Removes and returns the attribute with the given name, if present.

pub fn retain(&mut self, f: impl FnMut(&Attribute) -> bool)

Available on crate feature write only.

Retains only the attributes specified by the predicate.

If the closure returns false, the attribute is retained. Otherwise, the attribute is removed.

This method operates in place and visits every attribute exactly once.

See Also

• Self::extract_if to get an iterator of the removed attributes.

pub fn extract_if( &mut self, f: impl FnMut(&Attribute) -> bool, ) -> impl Iterator<Item = Attribute>

Available on crate feature write only.

Removes and returns only the attributes specified by the predicate.

If the closure returns true, the attribute is removed and yielded. Otherwise, the attribute is retained.

Drop

If the returned iterator is not exhausted, (e.g. dropped without iterating or iteration short-circuits), then the remaining attributes are retained.

Prefer Self::retain with a negated predicate if the returned iterator is not needed.

pub fn drain(&mut self) -> impl Iterator<Item = Attribute>

Available on crate feature write only.

Removes and returns all attributes.

pub fn clear(&mut self)

Available on crate feature write only.

Removes all attributes.

See Also

• Self::drain to get an iterator of the removed attributes.

impl Attributes

pub fn len(&self) -> usize

The number of Attribute entries contained within.

pub fn is_empty(&self) -> bool

Returns true if there are no attributes.

pub fn get(&self, index: usize) -> Option<&Attribute>

Returns the associated Attribute if the given index is less than Self::len, otherwise None.

pub fn iter(&self) -> AttributesIter<'_>

Returns an iterator over all Attribute entries.

pub fn by_name(&self, name: &str) -> Option<&Attribute>

Returns the Attribute with the given name if present, otherwise None.

See Also

• Self::get_value to get the attribute value directly.

pub fn get_value(&self, name: &str) -> Option<&str>

Returns the value of the Attribute with the given name if present, otherwise None.

pub fn has_name(&self, name: &str) -> bool

Returns true if an Attribute with the given name is present.

Trait Implementations

impl Clone for Attributes

fn clone(&self) -> Attributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Attributes

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

Formats the value using the given formatter.

impl Extend<Attribute> for Attributes

Available on crate feature write only.

fn extend<I: IntoIterator<Item = Attribute>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> IntoIterator for &'a mut Attributes

Available on crate feature write only.

type Item = &'a mut Attribute

The type of the elements being iterated over.

type IntoIter = AttributesIterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Attributes

type Item = &'a Attribute

The type of the elements being iterated over.

type IntoIter = AttributesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Attributes

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Attributes