Struct AsyncFile 

pub struct AsyncFile { /* private fields */ }

A file handle whose open, read, write, seek, flush, and metadata operations are all asynchronous.

Implementations

impl AsyncFile

pub async fn open(path: impl AsRef<Path>) -> Result<Self, FsError>

Open an existing file for reading.

pub async fn open_if_exists( path: impl AsRef<Path>, ) -> Result<Option<Self>, FsError>

Open an existing file, returning None when it does not exist.

pub async fn create(path: impl AsRef<Path>) -> Result<Self, FsError>

Create or truncate a file for writing.

pub async fn create_new(path: impl AsRef<Path>) -> Result<Self, FsError>

Create a new file, failing if it already exists.

pub async fn open_append(path: impl AsRef<Path>) -> Result<Self, FsError>

Open a file for appending, creating it when needed.

pub async fn open_write_at_end(path: impl AsRef<Path>) -> Result<Self, FsError>

Open a file for writing and position it at its current end.

pub async fn read_exact(&mut self, buffer: &mut [u8]) -> Result<(), FsError>

Read exactly the requested number of bytes.

pub async fn write_all(&mut self, buffer: &[u8]) -> Result<(), FsError>

Write all bytes in buffer.

pub async fn flush(&mut self) -> Result<(), FsError>

Flush buffered bytes to the operating system.

pub async fn sync_all(&self) -> Result<(), FsError>

Flush file contents and metadata to stable storage.

pub async fn sync_data(&self) -> Result<(), FsError>

Flush file contents to stable storage using the platform’s data-sync operation.

pub async fn seek(&mut self, position: SeekFrom) -> Result<u64, FsError>

Seek to a position and return the new offset.

pub async fn stream_position(&mut self) -> Result<u64, FsError>

Return the current stream position.

pub async fn metadata(&self) -> Result<Metadata, FsError>

Return metadata for the open file.

pub async fn set_len(&self, length: u64) -> Result<(), FsError>

Change the file length.

pub fn path(&self) -> &Path

Return the path used to open this file.

Trait Implementations

impl AsyncRead for AsyncFile

fn poll_read( self: Pin<&mut Self>, context: &mut Context<'_>, buffer: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for AsyncFile

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

Attempt to write bytes from buf into the object.

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

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

fn poll_shutdown( self: Pin<&mut Self>, context: &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.