Struct Cursor 

pub struct Cursor<'a> { /* private fields */ }

A cursor over a byte slice for sequential reading with endian-aware helpers.

All HDF5 file parsing goes through this type. It wraps a &[u8] and tracks the current position. Methods advance the position on success.

Implementations

impl<'a> Cursor<'a>

pub fn new(data: &'a [u8]) -> Self

Create a new cursor at position 0.

pub fn position(&self) -> u64

Current byte position.

pub fn set_position(&mut self, pos: u64)

Set the position.

pub fn len(&self) -> u64

Total length of the underlying data.

pub fn is_empty(&self) -> bool

Returns true if the underlying data is empty.

pub fn remaining(&self) -> u64

Remaining bytes from current position.

pub fn data(&self) -> &'a [u8]

Get the underlying data slice.

pub fn slice_from(&self, offset: u64) -> Result<&'a [u8]>

Get a slice starting from an absolute offset.

pub fn at_offset(&self, offset: u64) -> Result<Cursor<'a>>

Create a new cursor at a given absolute offset.

pub fn read_bytes(&mut self, n: usize) -> Result<&'a [u8]>

Read exactly n bytes and advance.

pub fn peek_bytes(&self, n: usize) -> Result<&'a [u8]>

Peek at the next n bytes without advancing.

pub fn skip(&mut self, n: usize) -> Result<()>

Skip n bytes.

pub fn align(&mut self, alignment: usize) -> Result<()>

Align position to alignment boundary.

pub fn read_u8(&mut self) -> Result<u8>

pub fn read_i8(&mut self) -> Result<i8>

pub fn read_u16_le(&mut self) -> Result<u16>

pub fn read_u32_le(&mut self) -> Result<u32>

pub fn read_u64_le(&mut self) -> Result<u64>

pub fn read_i16_le(&mut self) -> Result<i16>

pub fn read_i32_le(&mut self) -> Result<i32>

pub fn read_i64_le(&mut self) -> Result<i64>

pub fn read_f32_le(&mut self) -> Result<f32>

pub fn read_f64_le(&mut self) -> Result<f64>

pub fn read_u16_be(&mut self) -> Result<u16>

pub fn read_u32_be(&mut self) -> Result<u32>

pub fn read_u64_be(&mut self) -> Result<u64>

pub fn read_u16(&mut self, order: ByteOrder) -> Result<u16>

pub fn read_u32(&mut self, order: ByteOrder) -> Result<u32>

pub fn read_u64(&mut self, order: ByteOrder) -> Result<u64>

pub fn read_offset(&mut self, size: u8) -> Result<u64>

Read an offset (address) of size bytes (little-endian). HDF5 uses 2/4/8-byte offsets depending on superblock configuration.

pub fn read_length(&mut self, size: u8) -> Result<u64>

Read a length of size bytes (little-endian).

pub fn read_uvar(&mut self, size: usize) -> Result<u64>

Read a variable-size unsigned integer of 1..=8 bytes (little-endian).

pub fn is_undefined_offset(val: u64, offset_size: u8) -> bool

Check if an offset value represents the “undefined” address.

pub fn read_null_terminated_string(&mut self) -> Result<String>

Read a null-terminated UTF-8 string.

pub fn read_fixed_string(&mut self, len: usize) -> Result<String>

Read a fixed-length string, trimming null padding.

Trait Implementations

impl<'a> Clone for Cursor<'a>

fn clone(&self) -> Cursor<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.