Struct File 

pub struct File { /* private fields */ }

Async file handle supporting stateful streams and positioned reads.

Implementations

impl File

pub async fn open<P>(path: P) -> Result<File, Error>

where P: AsRef<Path>,

Open a file with default options (read-only)

pub async fn create<P>(path: P) -> Result<File, Error>

where P: AsRef<Path>,

Create a new file for writing (truncates if exists)

pub async fn open_with_options<P>( path: P, options: FileOpenOptions, ) -> Result<File, Error>

where P: AsRef<Path>,

Open a file with custom options

pub async fn read_to_string(&mut self) -> Result<String, Error>

Read entire file contents into a string

pub async fn read_to_end(&mut self) -> Result<Vec<u8>, Error>

Read entire file contents into a byte vector

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read data into a buffer

pub async fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write data from a buffer

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

Write all data from a buffer.

The whole buffer is one pool job: once submitted, it is written in full even if this future is dropped.

pub async fn write_str(&mut self, s: &str) -> Result<(), Error>

Write a string to the file

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

Flush any buffered data to disk

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

Synchronize all data and metadata to disk

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

Synchronize data (but not metadata) to disk

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

Seek to a specific position in the file

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

Get current position in the file

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

Get file metadata, after every stream operation already queued on this handle has finished.

pub fn path(&self) -> &Path

Get file path

pub fn stats(&self) -> &FileStats

Get statistics for stateful stream operations.

Positioned reads do not advance the stream and are not included.

Trait Implementations

impl AsyncLength for File

async fn len(&self) -> Result<u64, Error>

Return the total number of readable bytes.

fn is_empty(&self) -> impl Future<Output = Result<bool, Error>> + Send

Whether the source has no readable bytes.

impl AsyncRead for File

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

Attempt to read from the source into the provided buffer.

impl AsyncReadAt for File

async fn read_at(&self, offset: u64, buf: &mut [u8]) -> Result<(), Error>

Read exactly buf.len() bytes beginning at offset.

impl AsyncWrite for File

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

Attempt to write bytes from the buffer to the destination.

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

Attempt to flush pending writes.

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

Attempt to close/shutdown the write side of the stream.

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

Attempt to write bytes from several buffers in one operation.

fn is_write_vectored(&self) -> bool

Whether poll_write_vectored is cheaper than one poll_write per buffer.