Struct quick_xml::events::BytesText

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

Data from various events (most notably, Event::Text).

Implementations

impl<'a> BytesText<'a>

pub fn from_escaped<C: Into<Cow<'a, [u8]>>>(content: C) -> BytesText<'a>

Creates a new BytesText from an escaped byte sequence.

pub fn from_plain(content: &'a [u8]) -> BytesText<'a>

Creates a new BytesText from a byte sequence. The byte sequence is expected not to be escaped.

pub fn from_escaped_str<C: Into<Cow<'a, str>>>(content: C) -> BytesText<'a>

Creates a new BytesText from an escaped string.

pub fn from_plain_str(content: &'a str) -> BytesText<'a>

Creates a new BytesText from a string. The string is expected not to be escaped.

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

Ensures that all data is owned to extend the object’s lifetime if necessary.

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

gets escaped content

Searches for ‘&’ into content and try to escape the coded character if possible returns Malformed error with index within element if ‘&’ is not followed by ‘;’

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 escaped content with custom entities

Searches for ‘&’ into content and try to escape the coded character if possible returns Malformed error with index within element if ‘&’ is not followed by ‘;’ 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 unescape_and_decode_without_bom<B: BufRead>(
    &self,
    reader: &Reader<B>
) -> Result<String>

helper method to unescape then decode self using the reader encoding but without BOM (Byte order mark)

for performance reasons (could avoid allocating a String), it might be wiser to manually use

1. BytesText::unescaped()
2. Reader::decode(…)

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

helper method to unescape then decode self using the reader encoding with custom entities but without BOM (Byte order mark)

for performance reasons (could avoid allocating a String), it might be wiser to manually use

1. BytesText::unescaped()
2. Reader::decode(…)

Pre-condition

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

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

helper method to unescape then decode self using the reader encoding

for performance reasons (could avoid allocating a String), it might be wiser to manually use

1. BytesText::unescaped()
2. Reader::decode(…)

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

helper method to unescape then decode self using the reader encoding with custom entities

for performance reasons (could avoid allocating a String), it might be wiser to manually use

1. BytesText::unescaped()
2. Reader::decode(…)

Pre-condition

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

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

Gets escaped content.

Trait Implementations

impl<'a> Clone for BytesText<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BytesText<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for BytesText<'a>

type Target = [u8]

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> PartialEq<BytesText<'a>> for BytesText<'a>

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

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

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

This method tests for !=.

impl<'a> Eq for BytesText<'a>

impl<'a> StructuralEq for BytesText<'a>

impl<'a> StructuralPartialEq for BytesText<'a>