Struct ub::deserialize::File

pub struct File<'a, R: Read + Seek> { /* fields omitted */ }

A parsed file. Contains a reference where in the reader the file is located, implements Read, and contains a PathBuf

Implementations

impl<'a, R: Read + Seek> File<'a, R>

#[must_use]pub fn path(&self) -> &Path

Get a reference of the path this file is pointing at.

#[must_use]pub fn into_path(self) -> PathBuf

Discards all information and return path. I dunno if this is useful...

#[must_use]pub fn size(&self) -> u64

Gets the size of this file.

pub fn align(&mut self) -> Result<()>

Aligns the underlying reader to the position we last read at. Can be used to continue reading a file.

Errors

Same as [fs::File::seek()]

pub fn align_to_start(&mut self) -> Result<()>

Aligns the underlying reader to the start of this file, to start over and read it from the start.

Errors

Same as [fs::File::seek()]

Trait Implementations

impl<'a, R: Debug + Read + Seek> Debug for File<'a, R>

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

Formats the value using the given formatter.

impl<'a, R: Read + Seek> Read for File<'a, R>

pub 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.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

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

pub 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.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

pub 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.

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

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

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

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, R: Read + Seek> Seek for File<'a, R>

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

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

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

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

Returns the length of this stream (in bytes).

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

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

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