Struct shared_files::SharedFileWriter

pub struct SharedFileWriter<T> { /* private fields */ }

A writer for the shared temporary file.

Dropping the writer

Note that while dropping the writer while implicitly change it to “completed”, you must manually call SharedFileWriter::sync_all or SharedFileWriter::sync_data to ensure all content is flushed to the underlying buffer.

Implementations

impl<T> SharedFileWriter<T>

pub fn file_path(&self) -> &PathBufwhere T: FilePath,

Gets the file path.

pub async fn sync_all(&self) -> Result<(), T::SyncError>where T: SharedFileType,

Synchronizes data and metadata with the disk buffer.

pub async fn sync_data(&self) -> Result<(), T::SyncError>where T: SharedFileType,

Synchronizes data with the disk buffer.

pub async fn complete(self) -> Result<(), CompleteWritingError>where T: SharedFileType,

Completes the writing operation.

Use complete_no_sync if you do not wish to sync the file to disk.

pub fn complete_no_sync(self) -> Result<(), CompleteWritingError>

Completes the writing operation.

If you need to sync the file to disk, consider calling complete instead.

Trait Implementations

impl<T> AsyncWrite for SharedFileWriter<T>where T: AsyncWrite,

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<(), 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<T> Drop for SharedFileWriter<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'pin, T> Unpin for SharedFileWriter<T>where __SharedFileWriter<'pin, T>: Unpin,