Struct compio_fs::File

pub struct File { /* private fields */ }

A reference to an open file on the filesystem.

An instance of a File can be read and/or written depending on what options it was opened with. The File type provides positional read and write operations. The file does not maintain an internal cursor. The caller is required to specify an offset when issuing an operation.

Implementations

impl File

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

Attempts to open a file in read-only mode.

See the OpenOptions::open method for more details.

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

Opens a file in write-only mode.

This function will create a file if it does not exist, and will truncate it if it does.

See the OpenOptions::open function for more details.

pub fn close(self) -> impl Future<Output = Result<()>>

Close the file. If the returned future is dropped before polling, the file won’t be closed.

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

Available on Unix only.

Queries metadata about the underlying file.

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

Available on Unix only.

Changes the permissions on the underlying file.

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

Attempts to sync all OS-internal metadata to disk.

This function will attempt to ensure that all in-memory data reaches the filesystem before returning.

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

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

This is intended for use cases that must synchronize content, but don’t need the metadata on disk. The goal of this method is to reduce disk operations.

Note that some platforms may simply implement this in terms of sync_all.

Trait Implementations

impl AsRawFd for File

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncReadAt for File

async fn read_at<T: IoBufMut>(&self, buffer: T, pos: u64) -> BufResult<usize, T>

Like AsyncRead::read, except that it reads at a specified position.

async fn read_vectored_at<T: IoVectoredBufMut>( &self, buffer: T, pos: u64, ) -> BufResult<usize, T>

Like AsyncRead::read_vectored, except that it reads at a specified position.

impl AsyncWriteAt for &File

async fn write_at<T: IoBuf>( &mut self, buffer: T, pos: u64, ) -> BufResult<usize, T>

Like AsyncWrite::write, except that it writes at a specified position.

async fn write_vectored_at<T: IoVectoredBuf>( &mut self, buffer: T, pos: u64, ) -> BufResult<usize, T>

Like AsyncWrite::write_vectored, except that it writes at a specified position.

impl AsyncWriteAt for File

async fn write_at<T: IoBuf>(&mut self, buf: T, pos: u64) -> BufResult<usize, T>

Like AsyncWrite::write, except that it writes at a specified position.

async fn write_vectored_at<T: IoVectoredBuf>( &mut self, buf: T, pos: u64, ) -> BufResult<usize, T>

Like AsyncWrite::write_vectored, except that it writes at a specified position.

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl FromRawFd for File

Available on Unix only.

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl ToSharedFd<File> for File

fn to_shared_fd(&self) -> SharedFd<File>

Return a cloned SharedFd.