Struct quick_xml::events::BytesStart

pub struct BytesStart<'a> { /* fields omitted */ }

Opening tag data (Event::Start), with optional attributes.

<name attr="value">.

The name can be accessed using the name, local_name or unescaped methods. An iterator over the attributes is returned by the attributes method.

Implementations

impl<'a> BytesStart<'a>

pub fn borrowed(content: &'a [u8], name_len: usize) -> Self

Creates a new BytesStart from the given content (name + attributes).

Warning

&content[..name_len] is not checked to be a valid name

pub fn borrowed_name(name: &'a [u8]) -> BytesStart<'a>

Creates a new BytesStart from the given name.

Warning

&content is not checked to be a valid name

pub fn owned<C: Into<Vec<u8>>>(
    content: C,
    name_len: usize
) -> BytesStart<'static>

Creates a new BytesStart from the given content (name + attributes)

Owns its contents.

pub fn owned_name<C: Into<Vec<u8>>>(name: C) -> BytesStart<'static>

Creates a new BytesStart from the given name

Owns its contents.

pub fn into_owned(self) -> BytesStart<'static>

Converts the event into an owned event.

pub fn to_owned(&self) -> BytesStart<'static>

Converts the event into an owned event without taking ownership of Event

pub fn to_borrowed(&self) -> BytesStart<'_>

Converts the event into a borrowed event. Most useful when paired with to_end.

Example

use quick_xml::events::{BytesStart, Event};

struct SomeStruct<'a> {
    attrs: BytesStart<'a>,
    // ...
}

writer.write_event(Event::Start(self.attrs.to_borrowed()))?;
// ...
writer.write_event(Event::End(self.attrs.to_end()))?;

pub fn to_end(&self) -> BytesEnd<'_>

Creates new paired close tag

pub fn with_attributes<'b, I>(self, attributes: I) -> Self where
    I: IntoIterator,
    I::Item: Into<Attribute<'b>>, 

Consumes self and yield a new BytesStart with additional attributes from an iterator.

The yielded items must be convertible to Attribute using Into.

pub fn name(&self) -> &[u8]

Gets the undecoded raw tag name as a &[u8].

pub fn local_name(&self) -> &[u8]

Gets the undecoded raw local tag name (excluding namespace) as a &[u8].

All content up to and including the first : character is removed from the tag name.

pub fn unescaped(&self) -> Result<Cow<'_, [u8]>>

Gets the unescaped tag name.

XML escape sequences like “<” will be replaced by their unescaped characters like “<”.

See also unescaped_with_custom_entities()

pub fn unescaped_with_custom_entities<'s>(
    &'s self,
    custom_entities: &HashMap<Vec<u8>, Vec<u8>>
) -> Result<Cow<'s, [u8]>>

Gets the unescaped tag name, using custom entities.

XML escape sequences like “<” will be replaced by their unescaped characters like “<”. Additional entities can be provided in custom_entities.

Pre-condition

The keys and values of custom_entities, if any, must be valid UTF-8.

See also unescaped()

pub fn attributes(&self) -> Attributes<'_>

Returns an iterator over the attributes of this tag.

pub fn html_attributes(&self) -> Attributes<'_>

Returns an iterator over the HTML-like attributes of this tag (no mandatory quotes or =).

pub fn attributes_raw(&self) -> &[u8]

Gets the undecoded raw string with the attributes of this tag as a &[u8], including the whitespace after the tag name if there is any.

pub fn extend_attributes<'b, I>(&mut self, attributes: I) -> &mut BytesStart<'a> where
    I: IntoIterator,
    I::Item: Into<Attribute<'b>>, 

Add additional attributes to this tag using an iterator.

The yielded items must be convertible to Attribute using Into.

pub fn unescape_and_decode<B: BufRead>(
    &self,
    reader: &Reader<B>
) -> Result<String>

Returns the unescaped and decoded string value.

This allocates a String in all cases. For performance reasons it might be a better idea to instead use one of:

• unescaped(), as it doesn’t allocate when no escape sequences are used.
• Reader::decode(), as it only allocates when the decoding can’t be performed otherwise.

pub fn unescape_and_decode_with_custom_entities<B: BufRead>(
    &self,
    reader: &Reader<B>,
    custom_entities: &HashMap<Vec<u8>, Vec<u8>>
) -> Result<String>

Returns the unescaped and decoded string value with custom entities.

This allocates a String in all cases. For performance reasons it might be a better idea to instead use one of:

• unescaped_with_custom_entities(), as it doesn’t allocate when no escape sequences are used.
• Reader::decode(), as it only allocates when the decoding can’t be performed otherwise.

Pre-condition

The keys and values of custom_entities, if any, must be valid UTF-8.

pub fn push_attribute<'b, A: Into<Attribute<'b>>>(&mut self, attr: A)

Adds an attribute to this element.

pub fn set_name(&mut self, name: &[u8]) -> &mut BytesStart<'a>

Edit the name of the BytesStart in-place

Warning

name is not checked to be a valid name

pub fn clear_attributes(&mut self) -> &mut BytesStart<'a>

Remove all attributes from the ByteStart

pub fn try_get_attribute<N: AsRef<[u8]> + Sized>(
    &'a self,
    attr_name: N
) -> Result<Option<Attribute<'a>>>

Try to get an attribute

Trait Implementations

impl<'a> Clone for BytesStart<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BytesStart<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for BytesStart<'a>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl<'a> PartialEq<BytesStart<'a>> for BytesStart<'a>

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

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

fn ne(&self, other: &BytesStart<'a>) -> bool

This method tests for !=.

impl<'a> Eq for BytesStart<'a>

impl<'a> StructuralEq for BytesStart<'a>

impl<'a> StructuralPartialEq for BytesStart<'a>