Struct File

pub struct File<'a, B: BlockDevice, S: FileSync = Safe> { /* private fields */ }

Implementations

impl<'a, B: BlockDevice> File<'a, B, Safe>

pub unsafe fn into_unsafe(self) -> File<'a, B, Unsafe>

Remove the locking requirement for file Read/Writes.

Use only if sure that reads/writes will not happen on the same or multiple files by different cores at the same.

pub unsafe fn into_reader(self) -> Result<Reader<'a, B>, DeviceError>

Transform the File into a high-speed Reader with better caching and locking mechanisms.

impl<'a, B: BlockDevice> File<'a, B, Unsafe>

pub fn into_safe(self) -> File<'a, B, Safe>

impl<'a, B: BlockDevice, S: FileSync> File<'a, B, S>

pub fn cursor(&self) -> usize

pub fn is_dirty(&self) -> bool

pub fn available(&self) -> usize

pub fn is_readable(&self) -> bool

pub fn is_writeable(&self) -> bool

pub fn is_allocated(&self) -> bool

pub fn volume(&self) -> &Volume<'a, B>

pub fn delete(self) -> Result<(), DeviceError>

pub fn close(self) -> Result<(), DeviceError>

pub fn flush(&mut self) -> Result<(), DeviceError>

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

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

Does not save the file and keeps the current Cluster intact. To fully truncate a File entry, it must be opened with ‘Mode::TRUNCATE’.

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

Methods from Deref<Target = DirEntry>

pub fn size(&self) -> u32

pub fn name(&self) -> &str

pub fn offset(&self) -> u32

pub fn is_file(&self) -> bool

pub fn created(&self) -> &Time

pub fn attributes(&self) -> u8

pub fn modified(&self) -> &Time

pub fn cluster(&self) -> Cluster

pub fn is_directory(&self) -> bool

pub fn filename(&self) -> &ShortName

Trait Implementations

impl<B: BlockDevice, S: FileSync> Deref for File<'_, B, S>

type Target = DirEntry

The resulting type after dereferencing.

fn deref(&self) -> &DirEntry

Dereferences the value.

impl<B: BlockDevice, S: FileSync> Drop for File<'_, B, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<B: BlockDevice, S: FileSync> Read<DeviceError> for File<'_, B, S>

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

fn read_exact(&mut self, b: &mut [u8]) -> Result<(), Error<E>>

impl<B: BlockDevice, S: FileSync> Seek<DeviceError> for File<'_, B, S>

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

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

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

impl<B: BlockDevice, S: FileSync> Write<DeviceError> for File<'_, B, S>

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

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

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

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