Struct quick_xml::events::attributes::Attribute

pub struct Attribute<'a> {
    pub key: QName<'a>,
    pub value: Cow<'a, [u8]>,
}

A struct representing a key/value XML attribute.

Field value stores raw bytes, possibly containing escape-sequences. Most users will likely want to access the value using one of the unescape_value and decode_and_unescape_value functions.

Fields

key: QName<'a>

The key to uniquely define the attribute.

If Attributes::with_checks is turned off, the key might not be unique.

value: Cow<'a, [u8]>

The raw value of the attribute.

Implementations

impl<'a> Attribute<'a>

pub fn unescape_value(&self) -> XmlResult<Cow<'a, str>>

Available on non-crate feature encoding only.

Decodes using UTF-8 then unescapes the value.

This is normally the value you are interested in. Escape sequences such as > are replaced with their unescaped equivalents such as >.

This will allocate if the value contains any escape sequences.

See also unescape_value_with()

This method is available only if encoding feature is not enabled.

pub fn unescape_value_with<'entity>(
    &self,
    resolve_entity: impl Fn(&str) -> Option<&'entity str>
) -> XmlResult<Cow<'a, str>>

Available on non-crate feature encoding only.

Decodes using UTF-8 then unescapes the value, using custom entities.

This is normally the value you are interested in. Escape sequences such as > are replaced with their unescaped equivalents such as >. A fallback resolver for additional custom entities can be provided via resolve_entity.

This will allocate if the value contains any escape sequences.

See also unescape_value()

This method is available only if encoding feature is not enabled.

pub fn decode_and_unescape_value<B>(
    &self,
    reader: &Reader<B>
) -> XmlResult<Cow<'a, str>>

Decodes then unescapes the value.

This will allocate if the value contains any escape sequences or in non-UTF-8 encoding.

pub fn decode_and_unescape_value_with<'entity, B>(
    &self,
    reader: &Reader<B>,
    resolve_entity: impl Fn(&str) -> Option<&'entity str>
) -> XmlResult<Cow<'a, str>>

Decodes then unescapes the value with custom entities.

This will allocate if the value contains any escape sequences or in non-UTF-8 encoding.

Trait Implementations

impl<'a> Clone for Attribute<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Attribute<'a>

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

Formats the value using the given formatter.

impl<'a> From<(&'a [u8], &'a [u8])> for Attribute<'a>

fn from(val: (&'a [u8], &'a [u8])) -> Attribute<'a>

Creates new attribute from raw bytes. Does not apply any transformation to both key and value.

Examples

use quick_xml::events::attributes::Attribute;

let features = Attribute::from(("features".as_bytes(), "Bells & whistles".as_bytes()));
assert_eq!(features.value, "Bells & whistles".as_bytes());

impl<'a> From<(&'a str, &'a str)> for Attribute<'a>

fn from(val: (&'a str, &'a str)) -> Attribute<'a>

Creates new attribute from text representation. Key is stored as-is, but the value will be escaped.

Examples

use quick_xml::events::attributes::Attribute;

let features = Attribute::from(("features", "Bells & whistles"));
assert_eq!(features.value, "Bells & whistles".as_bytes());

impl<'a> From<Attr<&'a [u8]>> for Attribute<'a>

fn from(attr: Attr<&'a [u8]>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<Attribute<'a>> for Attribute<'a>

fn eq(&self, other: &Attribute<'a>) -> bool

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

const 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<'a> StructuralPartialEq for Attribute<'a>