Struct File

pub struct File<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize>
where
    D: BlockDevice,
    T: TimeSource,
{ /* private fields */ }

A handle for an open file on disk, which closes on drop.

In contrast to a RawFile, a File holds a mutable reference to its parent VolumeManager, which restricts which operations you can perform.

If you drop a value of this type, it closes the file automatically, and but error that may occur will be ignored. To handle potential errors, use the File::close method.

Implementations

impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> File<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

where D: BlockDevice, T: TimeSource,

pub fn new( raw_file: RawFile, volume_mgr: &'a VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>, ) -> File<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

Create a new File from a RawFile

pub fn read(&self, buffer: &mut [u8]) -> Result<usize, Error<D::Error>>

Read from the file

Returns how many bytes were read, or an error.

pub fn write(&self, buffer: &[u8]) -> Result<(), Error<D::Error>>

Write to the file

pub fn is_eof(&self) -> bool

Check if a file is at End Of File.

pub fn seek_from_current(&self, offset: i32) -> Result<(), Error<D::Error>>

Seek a file with an offset from the current position.

pub fn seek_from_start(&self, offset: u32) -> Result<(), Error<D::Error>>

Seek a file with an offset from the start of the file.

pub fn seek_from_end(&self, offset: u32) -> Result<(), Error<D::Error>>

Seek a file with an offset back from the end of the file.

pub fn length(&self) -> u32

Get the length of a file

pub fn offset(&self) -> u32

Get the current offset of a file

pub fn to_raw_file(self) -> RawFile

Convert back to a raw file

pub fn flush(&self) -> Result<(), Error<D::Error>>

Flush any written data by updating the directory entry.

pub fn close(self) -> Result<(), Error<D::Error>>

Consume the File handle and close it. The behavior of this is similar to using core::mem::drop or letting the File go out of scope, except this lets the user handle any errors that may occur in the process, whereas when using drop, any errors will be discarded silently.

Trait Implementations

impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Debug for File<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

where D: BlockDevice, T: TimeSource,

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

Formats the value using the given formatter.

impl<'a, D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Drop for File<'a, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

where D: BlockDevice, T: TimeSource,

fn drop(&mut self)

Executes the destructor for this type.

impl<D: BlockDevice, T: TimeSource, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> ErrorType for File<'_, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

type Error = Error<<D as BlockDevice>::Error>

Error type of all the IO operations on this type.

impl<D: BlockDevice, T: TimeSource, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Read for File<'_, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

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

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

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

Read the exact number of bytes required to fill buf.

impl<D: BlockDevice, T: TimeSource, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Seek for File<'_, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

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

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

fn rewind(&mut self) -> Result<(), Self::Error>

Rewind to the beginning of a stream.

fn stream_position(&mut self) -> Result<u64, Self::Error>

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

impl<D: BlockDevice, T: TimeSource, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Write for File<'_, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

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

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

fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

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

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