Struct Addr 

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

A 56 bit address, held in the low 56 bits of a u64.

The zero address is reserved to mean “no entry” so that a cleared bucket needs no separate occupancy bit. That costs the Inline space its zero value, which is fine because an inline zero is stored as the integer 0 with a type tag rather than as a bare address.

Implementations

impl Addr

pub const NONE: Addr

The absent address. A bucket entry holding this has no value.

pub const fn new(space: Space, offset: u64) -> Addr

Build an address.

Panics

If offset does not fit in 52 bits. An offset that large means the file has outgrown the address width, which is a design limit and not a runtime condition, so it is a panic rather than an error value.

pub const unsafe fn new_unchecked(space: Space, offset: u64) -> Addr

Build an address without checking the offset width.

Safety

offset must be at or below MAX_OFFSET. Passing a wider value silently corrupts the space bits, which sends a later read into the wrong world.

pub const fn to_bits(self) -> u64

The raw 56 bit value, as stored.

pub const fn from_bits(bits: u64) -> Addr

Rebuild from a raw 56 bit value.

Bits above 56 are dropped rather than trusted, because this value comes off disk and a corrupt high byte should not become a wild pointer.

pub const fn is_none(self) -> bool

Whether this address points at anything.

pub const fn is_some(self) -> bool

Whether this address points at something.

pub const fn offset(self) -> u64

The offset part.

pub const fn space_bits(self) -> u8

The raw space bits, before any check that they name a known space.

pub const fn space(self) -> Option<Space>

The space, or None if the bits name a space this build does not know.

A file written by a newer release can carry a space we have never heard of. That is a VersionTooNew condition for the caller to report, not a panic, so this returns an option rather than unwrapping.

Trait Implementations

impl Clone for Addr

fn clone(&self) -> Addr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Addr

impl Debug for Addr

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

Formats the value using the given formatter.

impl Default for Addr

fn default() -> Addr

Returns the “default value” for a type.

impl Eq for Addr

impl Hash for Addr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Addr

fn cmp(&self, other: &Addr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Addr

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Addr

fn partial_cmp(&self, other: &Addr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Addr