Struct ape_fatfs::file::File

pub struct File<'a, IO: ReadWriteSeek, TP, OCC> { /* private fields */ }

A FAT filesystem file object used for reading and writing data.

This struct is created by the open_file or create_file methods on Dir.

Implementations

impl<'a, IO: ReadWriteSeek, TP, OCC> File<'a, IO, TP, OCC>

pub fn truncate(&mut self) -> Result<(), Error<IO::Error>>

Truncate file in current position.

Errors

Error::Io will be returned if the underlying storage object returned an I/O error.

Panics

Will panic if this is the root directory.

pub fn extents( &mut self ) -> impl Iterator<Item = Result<Extent, Error<IO::Error>>> + 'a

Get the extents of a file on disk.

This returns an iterator over the byte ranges on-disk occupied by this file.

pub fn set_created(&mut self, date_time: DateTime)

👎Deprecated

Sets date and time of creation for this file.

Note: it is set to a value from the TimeProvider when creating a file. Deprecated: if needed implement a custom TimeProvider.

pub fn set_accessed(&mut self, date: Date)

👎Deprecated

Sets date of last access for this file.

Note: it is overwritten by a value from the TimeProvider on every file read operation. Deprecated: if needed implement a custom TimeProvider.

pub fn set_modified(&mut self, date_time: DateTime)

👎Deprecated

Sets date and time of last modification for this file.

Note: it is overwritten by a value from the TimeProvider on every file write operation. Deprecated: if needed implement a custom TimeProvider.

Trait Implementations

impl<IO: ReadWriteSeek, TP, OCC> Clone for File<'_, IO, TP, OCC>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<IO: ReadWriteSeek, TP, OCC> Drop for File<'_, IO, TP, OCC>

fn drop(&mut self)

Executes the destructor for this type.

impl<IO: ReadWriteSeek, TP, OCC> Io for File<'_, IO, TP, OCC>

type Error = Error<<IO as Io>::Error>

Error type of all the IO operations on this type.

impl<IO: ReadWriteSeek, TP: TimeProvider, OCC> Read for File<'_, IO, TP, OCC>where Error: From<Error<IO::Error>>,

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_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<IO: ReadWriteSeek, TP: TimeProvider, OCC> Read for File<'_, IO, TP, OCC>

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

Pull 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<IO: ReadWriteSeek, TP: TimeProvider, OCC> Seek for File<'_, IO, TP, OCC>where Error: From<Error<IO::Error>>,

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

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

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

Rewind to the beginning of a stream.

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

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

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

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

impl<IO: ReadWriteSeek, TP, OCC> Seek for File<'_, IO, TP, OCC>

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<IO: ReadWriteSeek, TP: TimeProvider, OCC> Write for File<'_, IO, TP, OCC>where Error: From<Error<IO::Error>>,

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

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

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

Attempts to write an entire buffer into this writer.

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

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

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

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<IO: ReadWriteSeek, TP: TimeProvider, OCC> Write for File<'_, IO, TP, OCC>

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, ensuring that 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.