Struct XmlElement

#[non_exhaustive]
pub struct XmlElement {
    pub name: ExpandedName<'static>,
    pub attributes: VecDeque<XmlAttribute>,
    pub children: XmlSeq<XmlChild>,
    pub enforce_prefix: IncludePrefix,
    pub preferred_prefix: Option<Prefix<'static>>,
}

An XML element.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: ExpandedName<'static>

The name of the element.

attributes: VecDeque<XmlAttribute>

The attributes of the element.

children: XmlSeq<XmlChild>

The children of the element.

enforce_prefix: IncludePrefix

Whether to enforce the prefix of the element.

preferred_prefix: Option<Prefix<'static>>

The preferred prefix of the element.

Implementations

impl XmlElement

pub fn new<T: Into<ExpandedName<'static>>>(name: T) -> Self

Creates a new XML element.

pub fn with_attribute<T: Into<XmlAttribute>>(self, attribute: T) -> Self

Adds an attribute to the element.

pub fn with_attributes<U: Into<XmlAttribute>, T: IntoIterator<Item = U>>( self, attributes: T, ) -> Self

Adds multiple attributes to the element.

pub fn with_child<T: Into<XmlChild>>(self, child: T) -> Self

Adds a child to the element.

pub fn with_children<U: Into<XmlChild>, T: IntoIterator<Item = U>>( self, children: T, ) -> Self

Adds multiple children to the element.

Trait Implementations

impl Clone for XmlElement

fn clone(&self) -> XmlElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlElement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XmlElement

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserializes a value from a deserializer.

fn deserialize_seq<D: Deserializer<'de>>(reader: D) -> Result<Self, D::Error>

Deserializes a value from a deserializer, but tries to do it from a sequence of values.

impl<'de> Deserializer<'de> for &'de XmlElement

type Error = XmlValueDeserializerError

The error type that can be returned from the deserializer.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Deserializes a value from the deserializer.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Deserializes a value from the deserializer, but tries to do it from a sequence of values.

impl From<XmlElement> for XmlChild

fn from(value: XmlElement) -> Self

Converts to this type from the input type.

impl From<XmlElement> for XmlValue

fn from(value: XmlElement) -> Self

Converts to this type from the input type.

impl Hash for XmlElement

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for XmlElement

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for XmlElement

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for XmlElement

fn partial_cmp(&self, other: &XmlElement) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for XmlElement

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize the type.

impl SerializeAttributes for &mut XmlElement

type Ok = ()

The type of the value that is returned when serialization is successful.

type Error = XmlValueSerializerError

The type of the error that is returned when serialization fails.

fn serialize_attribute<A: SerializeAttribute>( &mut self, a: &A, ) -> Result<Self::Ok, Self::Error>

Serializes an attribute.

impl<'s> SerializeElement for &'s mut XmlElement

type Ok = ()

The type of the value that is returned when serialization is successful.

type Error = XmlValueSerializerError

The type of the error that is returned when serialization fails.

type ChildrenSerializeSeq = &'s mut XmlSeq<XmlChild>

The type of the serializer that is returned when serializing the children of this element.

type SerializeElementAttributes = &'s mut XmlElement

The type of the serializer that is returned when serializing the attributes of this element.

fn include_prefix( &mut self, should_enforce: IncludePrefix, ) -> Result<Self::Ok, Self::Error>

Always serialize this element with the given prefix.

fn preferred_prefix( &mut self, preferred_prefix: Option<Prefix<'_>>, ) -> Result<Self::Ok, Self::Error>

Set the preferred prefix for this element.

fn serialize_children(self) -> Result<Self::ChildrenSerializeSeq, Self::Error>

Serialize the children of this element.

fn end(self) -> Result<Self::Ok, Self::Error>

End the serialization of this element with no children.

fn serialize_attributes( self, ) -> Result<Self::SerializeElementAttributes, Self::Error>

Serialize the attributes of this element.

impl<'s> SerializeElementAttributes for &'s mut XmlElement

type ChildrenSerializeSeq = &'s mut XmlSeq<XmlChild>

The type of the value that is returned when serialization is successful.

fn serialize_children(self) -> Result<Self::ChildrenSerializeSeq, Self::Error>

Serialize the children of this element.

fn end(self) -> Result<Self::Ok, Self::Error>

End the serialization of this element with no children.

impl Eq for XmlElement

impl StructuralPartialEq for XmlElement