Struct SubFile

pub struct SubFile<R> { /* private fields */ }

A seek-able sub-file with a start and end point within a larger file.

Implementations

impl<R: ReadAt> SubFile<R>

pub fn new(inner: Arc<R>, start: u64, len: u64) -> Result<Self>

Creates a sub-file from seek-able object.

This new file will its start and zero position at the current position of inner and extend up to len bytes.

pub fn len(&self) -> u64

Returns the total length of the sub-file, ignoring the current position.

pub fn is_empty(&self) -> bool

Returns true if the file is empty.

pub fn remaining(&self) -> u64

Returns the number of bytes remaining in the sub-file.

pub fn sub_file(&self, start: u64, len: u64) -> Result<Self>

Returns a new sub-file that is a sub-range of this one.

Trait Implementations

impl<R: ReadAt> ChunkReader for SubFile<R>

type T = SubFile<R>

The concrete type of reader returned by this trait

fn get_read(&self, start: u64) -> Result<Self::T>

Get a Read instance starting at the provided file offset

fn get_bytes(&self, start: u64, length: usize) -> Result<Bytes>

Get a range of data in memory as [Bytes]

impl<R: Clone> Clone for SubFile<R>

fn clone(&self) -> SubFile<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Debug for SubFile<R>

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

Formats the value using the given formatter.

impl<R: ReadAt> Length for SubFile<R>

fn len(&self) -> u64

Returns the amount of bytes of the inner source.

impl<R: ReadAt> Read for SubFile<R>

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>) -> Result<usize, Error>

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

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

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

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

Reads 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)

Reads the exact number of bytes required to fill cursor.

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

where 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<R: ReadAt> Seek for SubFile<R>

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

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

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

Returns the current seek position from the start of the 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 seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.