Struct File

pub struct File { /* private fields */ }

Available on crate feature tokio only.

Wrapper around tokio::fs::File which adds more helpful information to all errors.

Implementations

impl File

pub async fn open(path: impl Into<PathBuf>) -> Result<File>

Attempts to open a file in read-only mode.

Wrapper for tokio::fs::File::open.

pub async fn create(path: impl Into<PathBuf>) -> Result<File>

Opens a file in write-only mode.

Wrapper for tokio::fs::File::create.

pub fn from_std(std: File) -> File

Converts a crate::File to a tokio::fs::File.

Wrapper for tokio::fs::File::from_std.

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

Attempts to sync all OS-internal metadata to disk.

Wrapper for tokio::fs::File::sync_all.

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

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

Wrapper for tokio::fs::File::sync_data.

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

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

Wrapper for tokio::fs::File::set_len.

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

Queries metadata about the underlying file.

Wrapper for tokio::fs::File::metadata.

pub async fn try_clone(&self) -> Result<File>

Creates a new File instance that shares the same underlying file handle as the existing File instance. Reads, writes, and seeks will affect both File instances simultaneously.

Wrapper for tokio::fs::File::try_clone.

pub async fn into_std(self) -> File

Destructures File into a crate::File. This function is async to allow any in-flight operations to complete.

Wrapper for tokio::fs::File::into_std.

pub fn try_into_std(self) -> Result<File, File>

Tries to immediately destructure File into a crate::File.

Wrapper for tokio::fs::File::try_into_std.

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

Changes the permissions on the underlying file.

Wrapper for tokio::fs::File::set_permissions.

impl File

Methods added by fs-err that are not available on tokio::fs::File.

pub fn from_parts<P>(file: TokioFile, path: P) -> Self

where P: Into<PathBuf>,

Creates a File from a raw file and its path.

pub fn into_parts(self) -> (TokioFile, PathBuf)

Extract the raw file and its path from this File.

pub fn file(&self) -> &TokioFile

Returns a reference to the underlying tokio::fs::File.

pub fn file_mut(&mut self) -> &mut TokioFile

Returns a mutable reference to the underlying tokio::fs::File.

pub fn path(&self) -> &Path

Returns a reference to the path that this file was created with.

Trait Implementations

impl AsRawFd for File

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

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

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

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

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

fn from(f: File) -> Self

Converts to this type from the input type.

impl From<File> for File

fn from(f: File) -> Self

Converts to this type from the input type.