Struct opendal::Writer

pub struct Writer { /* private fields */ }

Writer is designed to write data into given path in an asynchronous manner.

Notes

Writer can be used in two ways:

• Sized: write data with a known size by specify the content length.
• Unsized: write data with an unknown size, also known as streaming.

All services will support sized writer and provide special optimization if the given data size is the same as the content length, allowing them to be written in one request.

Some services also supports unsized writer. They MAY buffer part of the data and flush them into storage at needs. And finally, the file will be available after close has been called.

Implementations

impl Writer

pub async fn write(&mut self, bs: impl Into<Bytes>) -> Result<()>

Write into inner writer.

pub async fn abort(&mut self) -> Result<()>

Abort inner writer.

pub async fn close(&mut self) -> Result<()>

Close the writer and make sure all data have been stored.

Trait Implementations

impl AsyncWrite for Writer

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

Writer makes sure that every write is flushed.

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_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 AsyncWrite for Writer

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>, _: &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.