Trait ramhorns::encoding::Encoder

pub trait Encoder {
    type Error;

    // Required methods
    fn write_unescaped(&mut self, part: &str) -> Result<(), Self::Error>;
    fn write_escaped(&mut self, part: &str) -> Result<(), Self::Error>;
    fn write_html<'a, I: Iterator<Item = Event<'a>>>(
        &mut self,
        iter: I
    ) -> Result<(), Self::Error>;
    fn format_unescaped<D: Display>(
        &mut self,
        display: D
    ) -> Result<(), Self::Error>;
    fn format_escaped<D: Display>(
        &mut self,
        display: D
    ) -> Result<(), Self::Error>;
}

A trait that wraps around either a String or std::io::Write, providing UTF-8 safe writing boundaries and special HTML character escaping.

Required Associated Types

type Error

Error type for this encoder

Required Methods

fn write_unescaped(&mut self, part: &str) -> Result<(), Self::Error>

Write a &str to this Encoder in plain mode.

fn write_escaped(&mut self, part: &str) -> Result<(), Self::Error>

Write a &str to this Encoder, escaping special HTML characters.

fn write_html<'a, I: Iterator<Item = Event<'a>>>( &mut self, iter: I ) -> Result<(), Self::Error>

Write HTML from an Iterator of pulldown_cmark Events.

fn format_unescaped<D: Display>( &mut self, display: D ) -> Result<(), Self::Error>

Write a Display implementor to this Encoder in plain mode.

fn format_escaped<D: Display>(&mut self, display: D) -> Result<(), Self::Error>

Write a Display implementor to this Encoder, escaping special HTML characters.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Encoder for String

type Error = NeverError

fn write_unescaped(&mut self, part: &str) -> Result<(), Self::Error>

fn write_escaped(&mut self, part: &str) -> Result<(), Self::Error>

fn write_html<'a, I: Iterator<Item = Event<'a>>>( &mut self, iter: I ) -> Result<(), Self::Error>

fn format_unescaped<D: Display>( &mut self, display: D ) -> Result<(), Self::Error>

fn format_escaped<D: Display>(&mut self, display: D) -> Result<(), Self::Error>

Implementors