Trait AsXmlText

pub trait AsXmlText {
    // Required method
    fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>;

    // Provided method
    fn as_optional_xml_text(&self) -> Result<Option<Cow<'_, str>>, Error> { ... }
}

Trait to convert a value to an XML text string.

Implementing this trait for a type allows it to be used both for XML character data within elements and for XML attributes. For XML attributes, the behaviour is defined by AsXmlText::as_optional_xml_text, while XML element text content uses AsXmlText::as_xml_text. Implementing AsXmlText automatically provides an implementation of AsOptionalXmlText.

If your type should only be used in XML attributes and has no correct serialisation in XML text, you should only implement AsOptionalXmlText and omit the AsXmlText implementation.

This trait is implemented for many standard library types implementing core::fmt::Display. In addition, the following feature flags can enable more implementations:

• jid: jid::Jid, jid::BareJid, jid::FullJid
• uuid: uuid::Uuid

Because of the unfortunate situation as described in FromXmlText, we are extremely liberal with accepting optional dependencies for this purpose. You are very welcome to make merge requests against this crate adding support for parsing third-party crates.

Required Methods

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert the value to an XML string in a context where an absent value cannot be represented.

Provided Methods

fn as_optional_xml_text(&self) -> Result<Option<Cow<'_, str>>, Error>

Convert the value to an XML string in a context where an absent value can be represented.

The provided implementation will always return the result of Self::as_xml_text wrapped into Some(.). By re-implementing this method, implementors can customize the behaviour for certain values.

Implementations on Foreign Types

impl AsXmlText for IpAddr

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::IpAddr to XML text via Display.

This implementation never fails.

impl AsXmlText for SocketAddr

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::SocketAddr to XML text via Display.

This implementation never fails.

impl AsXmlText for bool

This provides an implementation compliant with xsd::bool.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert a boolean to XML text.

true is converted to "true" and false is converted to "false". This implementation never fails.

impl AsXmlText for char

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert char to XML text via Display.

This implementation never fails.

impl AsXmlText for f32

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert f32 to XML text via Display.

This implementation never fails.

impl AsXmlText for f64

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert f64 to XML text via Display.

This implementation never fails.

impl AsXmlText for i8

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert i8 to XML text via Display.

This implementation never fails.

impl AsXmlText for i16

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert i16 to XML text via Display.

This implementation never fails.

impl AsXmlText for i32

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert i32 to XML text via Display.

This implementation never fails.

impl AsXmlText for i64

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert i64 to XML text via Display.

This implementation never fails.

impl AsXmlText for i128

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert i128 to XML text via Display.

This implementation never fails.

impl AsXmlText for isize

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert isize to XML text via Display.

This implementation never fails.

impl AsXmlText for str

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Return the borrowed string contents.

impl AsXmlText for u8

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert u8 to XML text via Display.

This implementation never fails.

impl AsXmlText for u16

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert u16 to XML text via Display.

This implementation never fails.

impl AsXmlText for u32

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert u32 to XML text via Display.

This implementation never fails.

impl AsXmlText for u64

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert u64 to XML text via Display.

This implementation never fails.

impl AsXmlText for u128

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert u128 to XML text via Display.

This implementation never fails.

impl AsXmlText for usize

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert usize to XML text via Display.

This implementation never fails.

impl AsXmlText for DomainPart

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::DomainPart to XML text via Display.

This implementation never fails.

impl AsXmlText for NodePart

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::NodePart to XML text via Display.

This implementation never fails.

impl AsXmlText for ResourcePart

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::ResourcePart to XML text via Display.

This implementation never fails.

impl AsXmlText for BareJid

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::BareJid to XML text via Display.

This implementation never fails.

impl AsXmlText for FullJid

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::FullJid to XML text via Display.

This implementation never fails.

impl AsXmlText for Jid

Available on crate feature jid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert jid::Jid to XML text via Display.

This implementation never fails.

impl AsXmlText for String

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Return the borrowed string contents.

impl AsXmlText for Ipv4Addr

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::Ipv4Addr to XML text via Display.

This implementation never fails.

impl AsXmlText for Ipv6Addr

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::Ipv6Addr to XML text via Display.

This implementation never fails.

impl AsXmlText for SocketAddrV4

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::SocketAddrV4 to XML text via Display.

This implementation never fails.

impl AsXmlText for SocketAddrV6

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::net::SocketAddrV6 to XML text via Display.

This implementation never fails.

impl AsXmlText for Uuid

Available on crate feature uuid only.

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert uuid::Uuid to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroI8

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroI8 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroI16

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroI16 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroI32

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroI32 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroI64

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroI64 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroI128

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroI128 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroIsize

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroIsize to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroU8

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroU8 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroU16

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroU16 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroU32

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroU32 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroU64

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroU64 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroU128

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroU128 to XML text via Display.

This implementation never fails.

impl AsXmlText for NonZeroUsize

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Convert core::num::NonZeroUsize to XML text via Display.

This implementation never fails.

impl<B: AsXmlText + ToOwned> AsXmlText for Cow<'_, B>

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Return the borrowed Cow contents.

impl<T: AsXmlText> AsXmlText for &T

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Delegate to the AsXmlText implementation on T.

impl<T: AsXmlText> AsXmlText for Box<T>

fn as_xml_text(&self) -> Result<Cow<'_, str>, Error>

Return the borrowed Box contents.

Implementors