Struct sync_file::RandomAccessFile

pub struct RandomAccessFile(/* private fields */);

A file with cross-platform positioned I/O.

Reading from this file or writing to it does not use its internal OS cursor, but it may move it anyway. This can cause surprising behaviour if shared with a File (this could be done with try_clone).

Implementations

impl RandomAccessFile

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

Attempts to open a file in read-only mode.

See File::open for details.

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

Opens a file in write-only mode.

See File::create for details.

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

Attempts to sync all OS-internal metadata to disk.

See File::sync_all for details.

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

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

See File::sync_data for details.

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

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

See File::set_len for details.

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

Queries metadata about the underlying file.

See File::metadata for details.

pub fn try_clone(&self) -> Result<RandomAccessFile>

Creates a new File instance that shares the same underlying file handle as the existing File instance

See File::try_clone for details.

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

Changes the permissions on the underlying file.

See File::set_permissions for details.

pub fn into_inner(self) -> File

Unwraps the inner File.

The file’s cursor position is unspecified.

Trait Implementations

impl AsFd for RandomAccessFile

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for RandomAccessFile

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for RandomAccessFile

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

Formats the value using the given formatter.

impl From<File> for RandomAccessFile

fn from(file: File) -> RandomAccessFile

Creates a new RandomAccessFile from an open File.

impl From<OwnedFd> for RandomAccessFile

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<RandomAccessFile> for File

fn from(file: RandomAccessFile) -> File

Converts to this type from the input type.

impl From<RandomAccessFile> for OwnedFd

fn from(f: RandomAccessFile) -> Self

Converts to this type from the input type.

impl From<RandomAccessFile> for SyncFile

fn from(file: RandomAccessFile) -> SyncFile

Creates a new SyncFile from an open RandomAccessFile.

The cursor starts at the beginning of the file.

impl FromRawFd for RandomAccessFile

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for RandomAccessFile

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl ReadAt for RandomAccessFile

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

Reads a number of bytes starting from a given offset.

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

Reads the exact number of byte required to fill buf from the given offset.

fn read_vectored_at( &self, bufs: &mut [IoSliceMut<'_>], offset: u64 ) -> Result<usize>

Like read_at, except that it reads into a slice of buffers.

impl WriteAt for RandomAccessFile

fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>

Writes a number of bytes starting from a given offset.

fn write_all_at(&self, buf: &[u8], offset: u64) -> Result<()>

Attempts to write an entire buffer starting from a given offset.

fn flush(&self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored_at(&self, bufs: &[IoSlice<'_>], offset: u64) -> Result<usize>

Like write_at, except that it writes from a slice of buffers.