Struct lzzzz::lz4f::AsyncWriteCompressor

pub struct AsyncWriteCompressor<W: AsyncWrite + Unpin> { /* fields omitted */ }

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

The AsyncWrite-based stream compressor.

Example

use async_std::fs::File;
use futures_lite::*;
use lzzzz::lz4f::AsyncWriteCompressor;

let mut f = File::create("foo.lz4").await?;
let mut w = AsyncWriteCompressor::new(&mut f, Default::default())?;

w.write_all(b"Hello world!").await?;

// You have to call close() to finalize the frame.
w.close().await?;

Implementations

impl<W: AsyncWrite + Unpin> AsyncWriteCompressor<W>

pub fn new(writer: W, prefs: Preferences) -> Result<Self>

Creates a new AsyncWriteCompressor<W>.

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

Creates a new AsyncWriteCompressor<W> with a dictionary.

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

Returns a mutable reference to the writer.

pub fn get_ref(&self) -> &W

Returns a shared reference to the writer.

pub fn into_inner(self) -> W

Returns ownership of the writer.

Trait Implementations

impl<W: AsyncWrite + Unpin> AsyncWrite for AsyncWriteCompressor<W>

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<()>>

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<W> Debug for AsyncWriteCompressor<W> where
    W: AsyncWrite + Unpin + Debug, 

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

Formats the value using the given formatter.

impl<W: AsyncWrite + Unpin> PinnedDrop for AsyncWriteCompressor<W>

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

impl<'pin, W: AsyncWrite + Unpin> Unpin for AsyncWriteCompressor<W> where
    __AsyncWriteCompressor<'pin, W>: Unpin, 

impl<W: AsyncWrite + Unpin> UnsafeUnpin for AsyncWriteCompressor<W>