Struct BaseAddress 

pub struct BaseAddress(/* private fields */);

The byte offset at which a file’s HDF5 image begins, as reported by Superblock::base_address.

Zero for a plain file, and the userblock size for a file that has one — 512 bytes for every .mat file this crate writes. Every address stored in a file’s metadata is relative to it, so an absolute position in the file is the stored address plus this. get is the number.

It is a type of its own rather than a u64 because the base and the addresses it shifts are both file offsets that mean different things, and mixing them is a defect this crate hit three separate times: a reader that forgets the base lands inside the userblock, and every test written against a file without one passes anyway.

Implementations

impl BaseAddress

pub const fn get(self) -> u64

The base as a plain integer: zero for a plain file, the userblock size for a file that has one.

Trait Implementations

impl Clone for BaseAddress

fn clone(&self) -> BaseAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BaseAddress

impl Debug for BaseAddress

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

Formats the value using the given formatter.

impl Eq for BaseAddress

impl PartialEq for BaseAddress

fn eq(&self, other: &BaseAddress) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BaseAddress