Struct Attributes

pub struct Attributes<'a> { /* private fields */ }

Stores all attributes of an HTML tag, as well as additional metadata such as id and class

Implementations

impl<'a> Attributes<'a>

pub fn len(&self) -> usize

Counts the number of attributes

pub fn is_empty(&self) -> bool

Checks whether this collection of attributes is empty

pub fn is_class_member<B: AsRef<[u8]>>(&self, member: B) -> bool

Checks whether a given string is in the class names list

pub fn get<B>(&self, key: B) -> Option<Option<&Bytes<'a>>>

where B: Into<Bytes<'a>>,

Checks whether this attributes collection contains a given key and returns its value

Attributes that exist in this tag but have no value set will have their inner Option set to None

pub fn contains<B>(&self, key: B) -> bool

where B: Into<Bytes<'a>>,

Checks whether this attributes collection contains a given key

pub fn remove<B>(&mut self, key: B) -> Option<Option<Bytes<'a>>>

where B: Into<Bytes<'a>>,

Removes an attribute from this collection and returns it.

As with Attributes::get(), the outer Option is set to None if the attribute does not exist. The inner option is set to None if the attribute exists but has no value.

Example

let mut dom = tl::parse("<span contenteditable=\"true\"></span>", Default::default()).unwrap();
let element = dom.nodes_mut()[0].as_tag_mut().unwrap();
let attributes = element.attributes_mut();

assert_eq!(attributes.remove("contenteditable"), Some(Some("true".into())));
assert_eq!(attributes.len(), 0);

pub fn remove_value<B>(&mut self, key: B) -> Option<Bytes<'a>>

where B: Into<Bytes<'a>>,

Removes the value of an attribute in this collection and returns it.

Example

let mut dom = tl::parse("<span contenteditable=\"true\"></span>", Default::default()).unwrap();
let element = dom.nodes_mut()[0].as_tag_mut().unwrap();
let attributes = element.attributes_mut();

assert_eq!(attributes.remove_value("contenteditable"), Some("true".into()));
assert_eq!(attributes.get("contenteditable"), Some(None));

pub fn get_mut<B>(&mut self, key: B) -> Option<Option<&mut Bytes<'a>>>

where B: Into<Bytes<'a>>,

Checks whether this attributes collection contains a given key and returns its value

pub fn insert<K, V>(&mut self, key: K, value: Option<V>)

where K: Into<Bytes<'a>>, V: Into<Bytes<'a>>,

Inserts a new attribute into this attributes collection

pub fn iter( &self, ) -> impl Iterator<Item = (Cow<'_, str>, Option<Cow<'_, str>>)> + '_

Returns an iterator (attribute_key, attribute_value) over the attributes of this HTMLTag

pub fn id(&self) -> Option<&Bytes<'a>>

Returns the id attribute of this HTML tag, if present

pub fn class(&self) -> Option<&Bytes<'a>>

Returns the class attribute of this HTML tag, if present

pub fn class_iter(&self) -> Option<impl Iterator<Item = &str> + '_>

Returns an iterator over all of the class members

pub fn unstable_raw(&self) -> &RawAttributesMap<'a>

Returns the underlying raw map for attributes

A note on stability

It is not guaranteed for the returned map to include all attributes. Some attributes may be stored in Attributes itself and not in the raw map. For that reason you should prefer to call methods on Attributes directly, i.e. Attributes::get() to lookup an attribute by its key.

Trait Implementations

impl<'a> Clone for Attributes<'a>

fn clone(&self) -> Attributes<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Attributes<'a>

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

Formats the value using the given formatter.