Struct ImageCursor 

pub struct ImageCursor { /* private fields */ }

Seekable cursor over an Image logical media stream.

Implementations

impl ImageCursor

pub fn position(&self) -> u64

Returns the current logical media byte position.

pub fn offset(&self) -> u64

Alias for ImageCursor::position.

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

Reads logical media bytes at the current cursor position and advances.

Errors

Returns an error if the underlying Image::read_at call fails or the cursor position would overflow.

pub fn read_buffer_at_offset( &mut self, buf: &mut [u8], offset: u64, ) -> Result<usize>

Seeks to offset, reads into buf, and advances by the bytes read.

Errors

Returns the same errors as ImageCursor::read_buffer.

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

Seeks the cursor using SeekFrom and returns the new position.

Errors

Returns an error if the seek would move before the start of the image or beyond u64 addressable space.

pub fn segment_filename(&self) -> Result<Option<&Path>>

Returns the segment containing the current cursor position.

Positions at or beyond the logical media size return Ok(None).

Errors

Returns an error if the image chunk geometry is malformed.

pub fn read_data_chunk(&mut self) -> Result<Option<DataChunk>>

Reads the data chunk at the current cursor position and advances to the next chunk.

Returns Ok(None) when the cursor is at or beyond the logical media end.

Errors

Returns an error if reading the chunk fails or the cursor position would overflow.

pub fn read_encoded_data_chunk(&mut self) -> Result<Option<EncodedDataChunk>>

Reads the encoded data chunk at the current cursor position and advances.

Returns Ok(None) when the cursor is at or beyond the logical media end.

Errors

Returns an error if reading the chunk fails or the cursor position would overflow.

Trait Implementations

impl Clone for ImageCursor

fn clone(&self) -> ImageCursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageCursor

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

Formats the value using the given formatter.

impl Read for ImageCursor

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<'_, u8>) -> 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<'_, u8>, ) -> 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” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

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

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

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

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.

impl Seek for ImageCursor

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.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.