Struct axfs::api::File

pub struct File { /* private fields */ }

An object providing access to an open file on the filesystem.

Implementations

impl File

pub fn open(path: &str) -> Result<Self>

Attempts to open a file in read-only mode.

pub fn create(path: &str) -> Result<Self>

Opens a file in write-only mode.

pub fn create_new(path: &str) -> Result<Self>

Creates a new file in read-write mode; error if the file exists.

pub fn options() -> OpenOptions

Returns a new OpenOptions object.

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

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

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

Queries metadata about the underlying file.

pub fn executable(&self) -> bool

Whether the file is executable.

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

Get the file attributes.

pub fn truncate(&mut self, len: usize) -> Result<()>

To truncate the file to a specified length.

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

fn readable(&self) -> bool

whether the file is readable

fn writable(&self) -> bool

whether the file is writable

fn executable(&self) -> bool

whether the file is executable

fn read_from_seek(&mut self, pos: SeekFrom, buf: &mut [u8]) -> AxResult<usize>

Read from position without changing cursor.

fn write_to_seek(&mut self, pos: SeekFrom, buf: &[u8]) -> AxResult<usize>

Write to position without changing cursor.

impl Read for File

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, AxError>

Available on crate feature alloc only.

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, AxError>

Available on crate feature alloc only.

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), AxError>

Read the exact number of bytes required to fill buf.

fn read_full(&mut self, buf: &mut [u8]) -> Result<usize, AxError>

Read the exact number of bytes required to fill buf.

impl Seek for File

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

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), AxError>

Rewind to the beginning of a stream.

fn stream_position(&mut self) -> Result<u64, AxError>

Returns the current seek position from the start of the stream.

impl Write for File

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

Write a buffer into this writer, returning how many bytes were written.

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

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

fn write_all(&mut self, buf: &[u8]) -> Result<(), AxError>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), AxError>

Writes a formatted string into this writer, returning any error encountered.