Struct compu::decompressor::write::Decompressor

pub struct Decompressor<D, W> { /* fields omitted */ }

Decompressor

It writes decompressed data to supplied writer that implements Write.

Note:

There is no buffering involved, as soon as data is ready, it is written. Which means it is not suitable for async IO where WouldBlock error can happen as it is considered a error case due to lack of any buffer

Usage

use compu::decoder::{Decoder, DecoderResult, BrotliDecoder};

let data = vec![5; 5];
let mut decoder = compu::decompressor::write::Decompressor::new(BrotliDecoder::default(), Vec::new());

let result = decoder.push(&data).expect("Successful decompression");

assert_eq!(result, DecoderResult::Finished);
assert!(decoder.decoder().is_finished());

Methods

impl<D: Decoder, W: Write> Decompressor<D, W>

pub fn new(decoder: D, writer: W) -> Self

Creates new instance

pub fn decoder(&self) -> &D

Returns reference to underlying decoder

pub fn writer(&self) -> &W

Returns reference to underlying writer

pub fn writer_mut(&mut self) -> &mut W

Returns mutable reference to underlying writer

pub fn push(&mut self, data: &[u8]) -> Result<DecoderResult>

Pushes data into, and returns Decoder's operation status

• DecoderResult::Finished indicates decompression has finished successfully.
• DecoderResult::NeedInput indicates that further data is necessary.
• DecoderResult::NeedOutput SHOULD not happen

Any other variants indicates error.

Returns io::Error if underlying writer fails, note that if io::Error happens then compressed data will be lost

pub fn take(self) -> W

Consumes self and returns underlying writer.

Trait Implementations

impl<D: Decoder, W: Write> Write for Decompressor<D, W>

fn write(&mut self, data: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.