Enum magnesium::XmlElement

pub enum XmlElement<'s> {
    StartTag {
        name: &'s str,
        attrs: &'s str,
    },
    EndTag {
        name: &'s str,
    },
    EmptyTag {
        name: &'s str,
        attrs: &'s str,
    },
    Text(&'s str),
    Comment(&'s str),
}

An element within an XML structure.

Variants

StartTag

Fields

name: &'s str

Name of this tag.

attrs: &'s str

Attribute string, parse this with a TagAttributeIterator.

An opening tag with a name and some attributes.

Eg: <books attr1="val1">

If the XML is well formed, then there will be an EndTag with a matching name later on. In between there can be any number of sub-entries.

EndTag

Fields

name: &'s str

Name of the tag being closed.

Closes the StartTag of the same name.

Eg: </books>

EmptyTag

Fields

name: &'s str

The tag’s name.

attrs: &'s str

The tag’s attribute string.

Parse this with a TagAttributeIterator.

An “empty” tag has no inner content, just attributes.

Eg: <enum name="GRAPHICS_POLYGON value="0x0001"/>

Text(&'s str)

Text between tags.

If there’s a “CDATA” entry it is parsed as a Text element.

Comment(&'s str)

Text between <!-- and -->.

Implementations

impl<'s> XmlElement<'s>

pub fn unwrap_start_tag(&self) -> (&'s str, &'s str)

Unwraps a StartTag variant into the inner (name, attrs) pair.

Panics

If the variant isn’t StartTag this will panic.

pub fn unwrap_end_tag(&self) -> &'s str

Unwraps an EndTag variant into the inner name.

Panics

If the variant isn’t EndTag this will panic.

pub fn unwrap_text(&self) -> &'s str

Unwraps a Text variant into the inner &str value.

Panics

If the variant isn’t Text this will panic.

pub fn unwrap_comment(&self) -> &'s str

Unwraps a Comment variant into the inner &str value.

Panics

If the variant isn’t Comment this will panic.

Trait Implementations

impl<'s> Clone for XmlElement<'s>

fn clone(&self) -> XmlElement<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for XmlElement<'s>

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

Formats the value using the given formatter.

impl<'s> Hash for XmlElement<'s>

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<'s> PartialEq<XmlElement<'s>> for XmlElement<'s>

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

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

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<'s> Copy for XmlElement<'s>

impl<'s> Eq for XmlElement<'s>

impl<'s> StructuralEq for XmlElement<'s>

impl<'s> StructuralPartialEq for XmlElement<'s>