Struct axfs::fops::File

pub struct File { /* private fields */ }

An opened file object, with open permissions and a cursor.

Implementations

impl File

pub fn open(path: &str, opts: &OpenOptions) -> AxResult<Self>

Opens a file at the path relative to the current directory. Returns a File object.

pub fn truncate(&self, size: u64) -> AxResult

Truncates the file to the specified size.

pub fn read(&mut self, buf: &mut [u8]) -> AxResult<usize>

Reads the file at the current position. Returns the number of bytes read.

After the read, the cursor will be advanced by the number of bytes read.

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

Reads the file at the given position. Returns the number of bytes read.

It does not update the file cursor.

pub fn write(&mut self, buf: &[u8]) -> AxResult<usize>

Writes the file at the current position. Returns the number of bytes written.

After the write, the cursor will be advanced by the number of bytes written.

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

Writes the file at the given position. Returns the number of bytes written.

It does not update the file cursor.

pub fn flush(&self) -> AxResult

Flushes the file, writes all buffered data to the underlying device.

pub fn seek(&mut self, pos: SeekFrom) -> AxResult<u64>

Sets the cursor of the file to the specified offset. Returns the new position after the seek.

pub fn get_attr(&self) -> AxResult<FileAttr>

Gets the file attributes.

pub fn readable(&self) -> bool

whether the file is readable.

pub fn writable(&self) -> bool

whether the file is writable.

pub fn executable(&self) -> bool

whether the file is executable.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.