Struct marked::Decoder

pub struct Decoder<Sink, A = NonAtomic> where
    Sink: TendrilSink<UTF8, A>,
    A: Atomicity,  { /* fields omitted */ }

A TendrilSink adaptor that takes bytes, decodes them as the given character encoding, while replacing any ill-formed byte sequences with U+FFFD replacement characters, and emits Unicode (StrTendril).

This allocates new tendrils for encodings other than UTF-8.

Implementations

impl<Sink, A> Decoder<Sink, A> where
    Sink: TendrilSink<UTF8, A>,
    A: Atomicity, 

pub fn new(encoding: &'static Encoding, sink: Sink) -> Self

pub fn inner_sink(&self) -> &Sink

Return reference to the inner sink.

pub fn read_to_end<R>(self, r: &mut R) -> Result<Sink::Output, Error> where
    Self: Sized,
    R: Read, 

Read until EOF of stream, processing each buffer, and finish this decoder. Returns the sink output or any io::Error.

Trait Implementations

impl<Sink, A> TendrilSink<Bytes, A> for Decoder<Sink, A> where
    Sink: TendrilSink<UTF8, A>,
    A: Atomicity, 

type Output = Sink::Output

What the overall result of processing is.

pub fn process(&mut self, t: Tendril<Bytes, A>)

Process this tendril.

pub fn error(&mut self, desc: Cow<'static, str>)

Indicates that an error has occurred.

pub fn finish(self) -> Sink::Output

Indicates the end of the stream.

pub fn one<T>(self, t: T) -> Self::Output where
    T: Into<Tendril<F, A>>, 

Process one tendril and finish.

pub fn from_iter<I>(self, i: I) -> Self::Output where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<Tendril<F, A>>, 

Consume an iterator of tendrils, processing each item, then finish.

pub fn read_from<R>(self, r: &mut R) -> Result<Self::Output, Error> where
    R: Read,
    F: SliceFormat<Slice = [u8]>, 

Read from the given stream of bytes until exhaustion and process incrementally, then finish. Return Err at the first I/O error.

pub fn from_file<P>(self, path: P) -> Result<Self::Output, Error> where
    P: AsRef<Path>,
    F: SliceFormat<Slice = [u8]>, 

Read from the file at the given path and process incrementally, then finish. Return Err at the first I/O error.