Struct embedded_sdmmc::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 */ }

Represents an open file on disk.

If you drop a value of this type, it closes the file automatically. However, it holds a mutable reference to its parent VolumeManager, which restricts which operations you can perform.

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 mut 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(&mut 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(&mut 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(&mut self, offset: i32) -> Result<(), Error<D::Error>>

Seek a file with an offset from the current position.

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

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

pub fn seek_from_end(&mut 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

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.