Struct Attribute 

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

A key/value XML attribute.

The value field stores raw bytes, possibly containing escape sequences. Most users will want the value via normalized_value or decoded_and_normalized_value.

Fields

key: QName<'a>

The key that uniquely identifies 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 normalized_value(&self, version: XmlVersion) -> XmlResult<Cow<'a, str>>

Returns the attribute value normalized as per the XML specification.

The document must be UTF-8 encoded. The characters \t, \r, \n are replaced with a space (0x20), and the five predefined entities are unescaped. This allocates unless no normalization is required.

pub fn normalized_value_with<'entity>( &self, version: XmlVersion, depth: usize, resolve_entity: impl FnMut(&str) -> Option<&'entity str>, ) -> XmlResult<Cow<'a, str>>

Returns the attribute value normalized as per the XML specification, using a custom entity resolver. The document must be UTF-8 encoded.

Parameters

• depth: maximum number of nested entities that can be expanded before EscapeError::TooManyNestedEntities is returned;
• resolve_entity: resolves named entities (predefined entities are not resolved by this function, but you may call resolve_predefined_entity).

pub fn decoded_and_normalized_value( &self, version: XmlVersion, decoder: Decoder, ) -> XmlResult<Cow<'a, str>>

Decodes using the provided decoder and returns the attribute value normalized as per the XML specification.

pub fn decoded_and_normalized_value_with<'entity>( &self, version: XmlVersion, decoder: Decoder, depth: usize, resolve_entity: impl FnMut(&str) -> Option<&'entity str>, ) -> XmlResult<Cow<'a, str>>

Decodes using the provided decoder and returns the attribute value normalized as per the XML specification, using a custom entity resolver.

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

👎Deprecated:

use Self::normalized_value()

Available on non-crate feature encoding only.

Returns the unescaped value.

Escape sequences such as > are replaced with their equivalents. This allocates if the value contains any escape sequences.

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

👎Deprecated:

use Self::normalized_value_with()

Available on non-crate feature encoding only.

Decodes using UTF-8, then unescapes the value using a custom entity resolver.

pub fn decode_and_unescape_value( &self, decoder: Decoder, ) -> XmlResult<Cow<'a, str>>

👎Deprecated:

use Self::decoded_and_normalized_value()

Decodes, then unescapes the value.

pub fn decode_and_unescape_value_with<'entity>( &self, decoder: Decoder, resolve_entity: impl FnMut(&str) -> Option<&'entity str>, ) -> XmlResult<Cow<'a, str>>

👎Deprecated:

use Self::decoded_and_normalized_value_with()

Decodes, then unescapes the value using a custom entity resolver.

pub fn as_bool(&self) -> Option<bool>

If the attribute value represents a valid boolean, returns Some, otherwise None. The valid representations are "true", "false", "1" and "0".

assert_eq!(Attribute::from(("attr", "false")).as_bool(), Some(false));
assert_eq!(Attribute::from(("attr", "1")).as_bool(), Some(true));
assert_eq!(Attribute::from(("attr", "not bool")).as_bool(), None);

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

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

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

Creates a new attribute from raw bytes, without transforming key or value.

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

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

Creates a new attribute from text. The key is stored as-is; the value is escaped.

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

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

Creates a new attribute from text. The key is stored as-is; the value is escaped.

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

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Attribute<'a>