Struct opendal::Writer

source ·

pub struct Writer { /* private fields */ }

Expand description

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

Notes

Writer is designed for appending multiple blocks which could lead to much requests. If only want to send all data in single chunk, please use Operator::write instead.

Implementations§

source §

impl Writer

source

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

Append data into writer.

It is highly recommended to align the length of the input bytes into blocks of 4MiB (except the last block) for better performance and compatibility.

source

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

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

Trait Implementations§

source §

impl AsyncWrite for Writer

source §

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

Writer makes sure that every write is flushed.

source §

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

Attempt to write bytes from buf into the object. Read more

source §

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

Attempt to close the object. Read more

§

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. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for Writer

Blanket Implementations§

source §

impl<T> Any for Twhere
T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

§

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

§

fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,

Creates a future which will entirely flush this AsyncWrite. Read more

§

fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,

Creates a future which will entirely close this AsyncWrite.

§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,

Creates a future which will write bytes from buf into the object. Read more

§

fn write_vectored<'a>(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
 Self: Unpin,

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where
Self: Unpin,

Write data into this object. Read more

§

fn into_sink<Item>(self) -> IntoSink<Self, Item>where
Item: AsRef<[u8]>,
Self: Sized,

Allow using an [AsyncWrite] as a Sink<Item: AsRef<[u8]>>. Read more

§

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where
Self: Unpin,

Writes some bytes into the byte stream. Read more

§

fn write_vectored<'a>(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>where
 Self: Unpin,

Like [write()][AsyncWriteExt::write()], except that it writes a slice of buffers. Read more

§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where
Self: Unpin,

Writes an entire buffer into the byte stream. Read more

§

fn flush(&mut self) -> FlushFuture<'_, Self>where
Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more

§

fn close(&mut self) -> CloseFuture<'_, Self>where
Self: Unpin,

Closes the writer. Read more

§

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>where
Self: Sized + Send + 'a,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. Read more

source §

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

source §

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T> Instrument for T

source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

§

type Init = T

The type for initializers.

§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source §

impl<T> Same<T> for T

§

type Output = T

Should always be Self

source §

impl<T, U> TryFrom for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source §

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

§

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

§

fn vzip(self) -> V

source §

impl<T> WithSubscriber for T

source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

§

impl<T> WriteExt for Twhere
T: AsyncWrite + ?Sized,

§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where
Self: Unpin,

Writes some bytes into the byte stream. Read more

§

fn flush(&mut self) -> FlushFuture<'_, Self>where
Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more

§

fn write_vectored<'a>(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>where
 Self: Unpin,

Like write, except that it writes from a slice of buffers. Read more

§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where
Self: Unpin,

Writes an entire buffer into the byte stream. Read more

§

fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> WriteFmtFuture<'a, Self>where
Self: Unpin,

Writes a formatted string into this writer, returning any error encountered. Read more

Struct opendal::Writer

Notes

Implementations§

impl Writer

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

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

Trait Implementations§

impl AsyncWrite for Writer

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

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

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

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

Auto Trait Implementations§

impl !RefUnwindSafe for Writer

impl Send for Writer

impl !Sync for Writer

impl Unpin for Writer

impl !UnwindSafe for Writer

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self>where Self: Unpin,

fn close(&mut self) -> Close<'_, Self>where Self: Unpin,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where Self: Unpin,

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectored<'a, Self>where Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item>where Item: AsRef<[u8]>, Self: Sized,

impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where Self: Unpin,

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectoredFuture<'a, Self>where Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>where Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self>where Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>where Self: Sized + Send + 'a,

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

fn compat_ref(&self) -> Compat<&T>

fn compat_mut(&mut self) -> Compat<&mut T>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> WriteExt for Twhere T: AsyncWrite + ?Sized,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>where Self: Unpin,

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectoredFuture<'a, Self>where Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where Self: Unpin,

fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> WriteFmtFuture<'a, Self>where Self: Unpin,

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,

fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,

fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where
Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item>where
Item: AsRef<[u8]>,
Self: Sized,

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where
Self: Unpin,

fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>where
Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where
Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>where
Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self>where
Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>>where
Self: Sized + Send + 'a,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

impl<T> WriteExt for Twhere
T: AsyncWrite + ?Sized,

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>where
Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self>where
Self: Unpin,

fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>where
Self: Unpin,

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>where
Self: Unpin,

fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> WriteFmtFuture<'a, Self>where
Self: Unpin,