Struct File

pub struct File { /* private fields */ }

Implementations

impl File

pub fn open<P: AsRef<Path>>(path: P) -> OpenFileFuture

pub fn create<P: AsRef<Path>>(path: P) -> OpenFileFuture

pub fn create_new<P: AsRef<Path>>(path: P) -> OpenFileFuture

Currenly this is only available in std::fs::File not [async-fs::File]

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

This is a different implementation that require &mut self while [async-fs::File] and std::fs::File doesn’t.

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

This is a different implementation that require &mut self while [async-fs::File] and std::fs::File doesn’t.

pub fn set_len<'a>(&'a mut self, size: u64) -> TruncateFuture<'a>

This is a different implementation that require &mut self while [async-fs::File] and std::fs::File doesn’t.

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

pub async fn set_permissions(&self, perm: Permissions) -> Result<()>

Currently always returns Err, because the permission of a file in File System API is determined when opening the file and can’t be changed afterwards.

Trait Implementations

impl AsyncRead for File

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncSeek for File

fn poll_seek( self: Pin<&mut Self>, _cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

File System API dosen’t fully expose the cursor of the file, so this is a simulated one and does not actually require async.

impl AsyncWrite for File

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

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

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

Attempt to close the object.

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.

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.