Trait TextCodec

Source

pub trait TextCodec<T> {
    // Required methods
    fn decode(&self, s: String) -> Result<T, Error>;
    fn encode<'x>(&self, value: &'x T) -> Result<Option<Cow<'x, str>>, Error>;

    // Provided method
    fn filtered<F: TextFilter>(self, filter: F) -> Filtered<F, Self, T>
       where Self: Sized { ... }
}

Expand description

Represent a way to encode/decode text data into a Rust type.

This trait can be used in scenarios where implementing FromXmlText and/or AsXmlText on a type is not feasible or sensible, such as the following:

The type originates in a foreign crate, preventing the implementation of foreign traits.
There is more than one way to convert a value to/from XML.

The codec to use for a text can be specified in the attributes understood by FromXml and AsXml derive macros. See the documentation of the FromXml derive macro for details.

Required Methods§

Source

fn decode(&self, s: String) -> Result<T, Error>

Decode a string value into the type.

Source

fn encode<'x>(&self, value: &'x T) -> Result<Option<Cow<'x, str>>, Error>

Encode the type as string value.

If this returns None, the string value is not emitted at all.

Provided Methods§

Source

fn filtered<F: TextFilter>(self, filter: F) -> Filtered<F, Self, T>
where Self: Sized,

Apply a filter to this codec.

Filters preprocess strings before they are handed to the codec for parsing, allowing to, for example, make the codec ignore irrelevant content by stripping it.