Struct lzzzz::lz4f::AsyncBufReadCompressor

pub struct AsyncBufReadCompressor<R: AsyncBufRead + Unpin> { /* fields omitted */ }

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

The AsyncBufRead-based streaming compressor.

Example

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

let mut f = File::open("foo.txt").await?;
let mut b = BufReader::new(f);
let mut r = AsyncBufReadCompressor::new(&mut b, Default::default())?;

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

Implementations

impl<R: AsyncBufRead + Unpin> AsyncBufReadCompressor<R>

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

Creates a new AsyncBufReadCompressor<R>.

pub fn with_dict(
    reader: R,
    prefs: Preferences,
    dict: Dictionary
) -> Result<Self>

Creates a new AsyncBufReadCompressor<R> with a dictionary.

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<R: AsyncBufRead + Unpin> AsyncBufRead for AsyncBufReadCompressor<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<R: AsyncBufRead + Unpin> AsyncRead for AsyncBufReadCompressor<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 AsyncBufReadCompressor<R> where
    R: AsyncBufRead + Unpin + Debug, 

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

Formats the value using the given formatter.

impl<R: AsyncBufRead + Unpin> PinnedDrop for AsyncBufReadCompressor<R>

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

impl<'pin, R: AsyncBufRead + Unpin> Unpin for AsyncBufReadCompressor<R> where
    __AsyncBufReadCompressor<'pin, R>: Unpin, 

impl<R: AsyncBufRead + Unpin> UnsafeUnpin for AsyncBufReadCompressor<R>