Trait Serializer

pub trait Serializer: Sized {
    type Ok;
    type Error: Error;
    type SerializeElement: SerializeElement<Ok = Self::Ok, Error = Self::Error>;
    type SerializeSeq: SerializeSeq<Ok = Self::Ok, Error = Self::Error>;

    // Required methods
    fn serialize_text<S: AsRef<str>>(
        self,
        text: S,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_cdata<S: AsRef<str>>(
        self,
        text: S,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_element(
        self,
        name: &ExpandedName<'_>,
    ) -> Result<Self::SerializeElement, Self::Error>;
    fn serialize_seq(self) -> Result<Self::SerializeSeq, Self::Error>;
    fn serialize_decl<S: AsRef<str>>(
        self,
        version: S,
        encoding: Option<S>,
        standalone: Option<S>,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_pi<S: AsRef<[u8]>>(
        self,
        target: S,
        content: S,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_comment<S: AsRef<[u8]>>(
        self,
        text: S,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_doctype<S: AsRef<[u8]>>(
        self,
        text: S,
    ) -> Result<Self::Ok, Self::Error>;
    fn serialize_none(self) -> Result<Self::Ok, Self::Error>;
}

A serializer receives serialization instructions from a Serialize implementation and produces serialized output.

Required Associated Types

type Ok

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

type Error: Error

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

type SerializeElement: SerializeElement<Ok = Self::Ok, Error = Self::Error>

The type of the serializer that is used to serialize an element with children.

type SerializeSeq: SerializeSeq<Ok = Self::Ok, Error = Self::Error>

The type of the serializer that is used to serialize a sequence of elements.

Required Methods

fn serialize_text<S: AsRef<str>>(self, text: S) -> Result<Self::Ok, Self::Error>

Serialize a text node.

fn serialize_cdata<S: AsRef<str>>( self, text: S, ) -> Result<Self::Ok, Self::Error>

Serialize a CDATA section.

fn serialize_element( self, name: &ExpandedName<'_>, ) -> Result<Self::SerializeElement, Self::Error>

Serialize an element with children.

fn serialize_seq(self) -> Result<Self::SerializeSeq, Self::Error>

Serialize a sequence of elements.

fn serialize_decl<S: AsRef<str>>( self, version: S, encoding: Option<S>, standalone: Option<S>, ) -> Result<Self::Ok, Self::Error>

Serialize an XML declaration.

fn serialize_pi<S: AsRef<[u8]>>( self, target: S, content: S, ) -> Result<Self::Ok, Self::Error>

Serialize a processing instruction.

fn serialize_comment<S: AsRef<[u8]>>( self, text: S, ) -> Result<Self::Ok, Self::Error>

Serialize a comment.

fn serialize_doctype<S: AsRef<[u8]>>( self, text: S, ) -> Result<Self::Ok, Self::Error>

Serialize a doctype declaration.

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

Serialize nothing.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Serializer for &mut XmlText

type Ok = ()

type Error = XmlValueSerializerError

type SerializeElement = NoopDeSerializer<<&mut XmlText as Serializer>::Ok, XmlValueSerializerError>

type SerializeSeq = NoopDeSerializer<<&mut XmlText as Serializer>::Ok, XmlValueSerializerError>

impl<'s> Serializer for &'s mut &mut XmlSeq<XmlChild>

type Ok = ()

type Error = XmlValueSerializerError

type SerializeSeq = &'s mut XmlSeq<XmlChild>

type SerializeElement = &'s mut XmlElement

impl<'s> Serializer for &'s mut &mut XmlSeq<XmlValue>

type Ok = ()

type Error = XmlValueSerializerError

type SerializeSeq = &'s mut XmlSeq<XmlValue>

type SerializeElement = &'s mut XmlElement

impl<'s> Serializer for &'s mut XmlValue

type Ok = ()

type Error = XmlValueSerializerError

type SerializeSeq = &'s mut XmlSeq<XmlValue>

type SerializeElement = &'s mut XmlElement