Skip to main content

Decoder

Struct Decoder 

Source
ⓘRead
pub struct Decoder<R: Read> { /* private fields */ }
Expand description

Streaming decompressor implementing std::io::Read.

Pulls compressed bytes from the inner reader and yields decompressed bytes. Reads until the inner reader ends, so concatenated archives decode as one stream; on a source that stays open after one frame, set Decoder::multistream to false. Returns io::ErrorKind::UnexpectedEof if the inner reader is drained before the ZXC footer is reached.

Decoder is single-threaded; one stream per reader.

§Example

use std::io::Read;
use zxc::Decoder;

let frame: &[u8] = &[]; // a ZXC frame
let mut dec = Decoder::new(frame).unwrap();
let mut buf = Vec::new();
dec.read_to_end(&mut buf).unwrap();

Implementations§

Source§

impl<R: Read> Decoder<R>

Source

pub fn new(reader: R) -> Result<Self, Error>

Creates a decoder with default decompression options: checksums are verified when a frame carries them.

Source

pub fn with_options( reader: R, opts: Option<&DecompressOptions>, ) -> Result<Self, Error>

Creates a decoder honouring opts.

Source

pub fn multistream(self, enabled: bool) -> Self

Decodes concatenated archives as one stream (true, the default), or stops after the first frame, as on a source that stays open after it. Bytes read ahead past that frame are then lost to the caller.

Source

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

Source

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying reader.

Source

pub fn into_inner(self) -> R

Consumes the decoder and returns the inner reader.

Source

pub fn finished(&self) -> bool

Reports whether the input so far ends on a validated footer.

Trait Implementations§

Source§

impl<R: Read> Read for Decoder<R>

Source§

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
Source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · Source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

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

Reads the exact number of bytes required to fill buf. Read more
Source§

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
Source§

fn read_buf_exact( &mut self, cursor: BorrowedCursor<'_, u8>, ) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self> ⓘ
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R> ⓘ
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self> ⓘ
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
Source§

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>
where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)
Read and return a fixed array of bytes from this source. Read more
Source§

fn read_le<T>(&mut self) -> Result<T, Error>
where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)
Read and return a type (e.g. an integer) in little-endian order. Read more
Source§

fn read_be<T>(&mut self) -> Result<T, Error>
where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)
Read and return a type (e.g. an integer) in big-endian order. Read more

Auto Trait Implementations§

§

impl<R> !Sync for Decoder<R>

§

impl<R> Forget for Decoder<R>

§

impl<R> Freeze for Decoder<R>
where R: Freeze,

§

impl<R> Move for Decoder<R>

§

impl<R> RefUnwindSafe for Decoder<R>
where R: RefUnwindSafe,

§

impl<R> Send for Decoder<R>
where R: Send,

§

impl<R> Unpin for Decoder<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for Decoder<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for Decoder<R>
where R: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.