Struct lzzzz::lz4f::AsyncBufReadDecompressor

pub struct AsyncBufReadDecompressor<'a, R: AsyncBufRead + Unpin> { /* fields omitted */ }

This is supported on feature="async-io" only.

The AsyncBufRead-based streaming decompressor.

Example

use async_std::{fs::File, io::BufReader, prelude::*};
use lzzzz::lz4f::AsyncBufReadDecompressor;

let mut f = File::open("foo.lz4").await?;
let mut b = BufReader::new(f);
let mut r = AsyncBufReadDecompressor::new(&mut b)?;

let mut buf = Vec::new();
r.read_frame_info().await?;
r.read_to_end(&mut buf).await?;

Implementations

impl<'a, R: AsyncBufRead + Unpin> AsyncBufReadDecompressor<'a, R>

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

Creates a new AsyncBufReadDecompressor<R>.

pub fn set_dict<D>(&mut self, dict: D) where
    D: Into<Cow<'a, [u8]>>, 

Sets the dictionary.

pub async fn read_frame_info<'_>(&'_ mut self) -> Result<FrameInfo>

Reads the frame header asynchronously and returns FrameInfo.

Calling this function before any AsyncRead or AsyncBufRead operations does not consume the frame body.

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

Returns a mutable reference to the reader.

pub fn get_ref(&self) -> &R

Returns a shared reference to the reader.

pub fn into_inner(self) -> R

Returns ownership of the reader.

Trait Implementations

impl<'a, R: AsyncBufRead + Unpin> AsyncBufRead for AsyncBufReadDecompressor<'a, R>

fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to [poll_read].

impl<'a, R: AsyncBufRead + Unpin> AsyncRead for AsyncBufReadDecompressor<'a, R>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<R, '_> Debug for AsyncBufReadDecompressor<'_, R> where
    R: AsyncBufRead + Unpin + Debug, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, R: AsyncBufRead + Unpin> PinnedDrop for AsyncBufReadDecompressor<'a, R>

unsafe fn drop(self: Pin<&mut Self>)

impl<'pin, 'a, R: AsyncBufRead + Unpin> Unpin for AsyncBufReadDecompressor<'a, R> where
    __AsyncBufReadDecompressor<'pin, 'a, R>: Unpin, 

impl<'a, R: AsyncBufRead + Unpin> UnsafeUnpin for AsyncBufReadDecompressor<'a, R>