Skip to main content

Writer

Struct Writer 

Source
pub struct Writer<W>
where W: Write,
{ /* private fields */ }
Expand description

Writes a sequence of generic XML events to an underlying std::io::Write.

This is a thin wrapper around quick_xml::Writer, scoped to xml-core’s own error type so that callers never need to depend on quick_xml directly.

Implementations§

Source§

impl<W> Writer<W>
where W: Write,

Source

pub fn new(inner: W) -> Writer<W>

Creates a new writer around the given output.

Source

pub fn write_event<'a, E>(&mut self, event: E) -> Result<(), Error>
where E: Into<Event<'a>>,

Writes a single XML event to the underlying output.

Source

pub fn into_inner(self) -> W

Consumes this writer, returning the underlying output.

Source

pub fn write_raw(&mut self, xml: &str) -> Result<(), Error>

Writes a pre-formed, already-valid fragment of UTF-8 XML directly to the underlying output, bypassing the event model entirely.

For embedding fixed, non-configurable XML content that has no need to be rebuilt one event at a time — e.g. a large, entirely static boilerplate payload a higher-level crate always writes verbatim. The caller is responsible for the fragment being well-formed and safe to splice in at its call site (no XML declaration, no dangling open tags, valid as a sequence of complete sibling elements).

Auto Trait Implementations§

§

impl<W> Freeze for Writer<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Writer<W>
where W: RefUnwindSafe,

§

impl<W> Send for Writer<W>
where W: Send,

§

impl<W> Sync for Writer<W>
where W: Sync,

§

impl<W> Unpin for Writer<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for Writer<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for Writer<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.