Struct object_store::buffered::BufWriter

pub struct BufWriter { /* private fields */ }

An async buffered writer compatible with the tokio IO traits

This writer adaptively uses ObjectStore::put or ObjectStore::put_multipart depending on the amount of data that has been written.

Up to capacity bytes will be buffered in memory, and flushed on shutdown using ObjectStore::put. If capacity is exceeded, data will instead be streamed using ObjectStore::put_multipart

Implementations

impl BufWriter

pub fn new(store: Arc<dyn ObjectStore>, path: Path) -> Self

Create a new BufWriter from the provided ObjectStore and Path

pub fn with_capacity( store: Arc<dyn ObjectStore>, path: Path, capacity: usize, ) -> Self

Create a new BufWriter from the provided ObjectStore, Path and capacity

pub fn with_max_concurrency(self, max_concurrency: usize) -> Self

Override the maximum number of in-flight requests for this writer

Defaults to 8

pub fn with_attributes(self, attributes: Attributes) -> Self

Set the attributes of the uploaded object

pub fn with_tags(self, tags: TagSet) -> Self

Set the tags of the uploaded object

pub async fn put(&mut self, bytes: Bytes) -> Result<()>

Write data to the writer in Bytes.

Unlike AsyncWrite::poll_write, put can write data without extra copying.

This API is recommended while the data source generates Bytes.

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

Abort this writer, cleaning up any partially uploaded state

Panic

Panics if this writer has already been shutdown or aborted

Trait Implementations

impl AsyncWrite for BufWriter

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

Attempt to write bytes from buf into the object.

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

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

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 Debug for BufWriter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.