Struct axfs::api::File

source ·
pub struct File { /* private fields */ }
Expand description

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

Implementations§

source§

impl File

source

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

Attempts to open a file in read-only mode.

source

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

Opens a file in write-only mode.

source

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

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

source

pub fn options() -> OpenOptions

Returns a new OpenOptions object.

source

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

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

source

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

Queries metadata about the underlying file.

Trait Implementations§

source§

impl Read for File

source§

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.
source§

impl Seek for File

source§

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

Seek to an offset, in bytes, in a stream. Read more
§

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

Rewind to the beginning of a stream. Read more
§

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

Returns the current seek position from the start of the stream. Read more
source§

impl Write for File

source§

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

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

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.

Auto Trait Implementations§

§

impl Freeze for File

§

impl !RefUnwindSafe for File

§

impl Send for File

§

impl Sync for File

§

impl Unpin for File

§

impl !UnwindSafe for File

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.