Struct File 

pub struct File { /* private fields */ }

A view into a file on the filesystem.

An instance of File can be read or written to depending on the options it was opened with. Files also implement Seek to alter the logical cursor position of the internal file.

This struct is a single element tuple containing a std::fs::File that implements rsfs::File and has unix extensions.

Examples

let fs = rsfs::disk::FS;
let mut f = fs.create_file("f").await?;
assert_eq!(f.write(&[1, 2, 3]).await?, 3);

Trait Implementations

impl AsyncRead for File

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

Attempts to read from the AsyncRead into buf.

impl AsyncSeek for File

fn start_seek(self: Pin<&mut Self>, position: SeekFrom) -> Result<()>

Attempts to seek to an offset, in bytes, in a stream.

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

Waits for a seek operation to complete.

impl AsyncWrite for File

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

Attempt to write bytes from buf into the object.

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

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 Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl File for File

type Metadata = Metadata

The Metadata type in the same module implementing this trait.

type Permissions = Permissions

The Permissions type in the same module implementing this trait.

fn sync_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attempts to sync all OS-internal metadata to the filesystem.

fn sync_data<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This function is similar to sync_all, except that it may not synchronize metadata to the filesystem.

fn set_len<'life0, 'async_trait>( &'life0 self, size: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Truncates or extends the underlying file, updating the size of this file to become size.

fn metadata<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Metadata>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Queries information about the underlying file.

fn try_clone<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates a new, independently owned handle to the underlying file.

fn set_permissions<'life0, 'async_trait>( &'life0 self, perm: Self::Permissions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Changes the permissions on the underlying file.

impl FileExt for File

fn read_at<'life0, 'life1, 'async_trait>( &'life0 self, buf: &'life1 mut [u8], offset: u64, ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Reads a number of bytes starting from the given offset, returning the number of bytes read.

fn write_at<'life0, 'life1, 'async_trait>( &'life0 self, buf: &'life1 [u8], offset: u64, ) -> Pin<Box<dyn Future<Output = Result<usize>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes a number of bytes starting from the given offset, returning the number of bytes written.