Struct noodles_bgzf::async::writer::Writer

pub struct Writer<W> { /* private fields */ }

An async BGZF writer.

Implementations

impl<W> Writer<W>

where W: AsyncWrite + Unpin,

pub fn new(inner: W) -> Self

Creates an async BGZF writer with a default compression level.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::AsyncWriter::new(Vec::new());

pub fn into_inner(self) -> W

Returns the underlying writer.

Examples

use noodles_bgzf as bgzf;
let writer = bgzf::AsyncWriter::new(Vec::new());
assert!(writer.into_inner().is_empty());

Trait Implementations

impl<W> AsyncWrite for Writer<W>

where W: AsyncWrite + Unpin,

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<()>>

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<'__pin, W> Unpin for Writer<W>

where __Origin<'__pin, W>: Unpin,