Struct SpatialFrameId 

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

Unique ID of a reference frame.

Memory

The internal number is a NonZeroU32, that means that Option<SpatialFrameId> and SpatialFrameId are the same size as u32.

As Hash

The generated internal number has good statistical distribution and can be used as its own hash, although it is not cryptographically safe, as it is simply a sequential counter scrambled using a modified splitmix64.

Static

The unique ID cannot be generated at compile time, but you can use the static_id! macro to declare a lazy static that instantiates the ID.

Exhaustion Handling

If more IDs are generated them u32::MAX an error is logged, the internal counter is reset and ids are reused.

Implementations

impl SpatialFrameId

pub fn new_unique() -> SpatialFrameId

Generates a new unique ID.

pub fn get(self) -> u32

Retrieve the underlying value.

pub fn sequential(self) -> u32

Un-scramble the underlying value to get the original sequential count number.

If two IDs, id0 and id1 where generated by the same thread then id0.sequential() < id1.sequential().

pub fn from_raw(raw: u32) -> SpatialFrameId

Creates an ID from a raw value.

The value must not be zero, panics if it is, the value must have been provided by get otherwise the ID will not be unique.

pub fn from_sequential(num: u32) -> SpatialFrameId

Creates an ID from a sequential number.

Safety

The value must not be zero, panics if it is, the value must have been provided by sequential otherwise the ID will not be unique.

Trait Implementations

impl Clone for SpatialFrameId

fn clone(&self) -> SpatialFrameId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpatialFrameId

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

Formats the value using the given formatter.

impl From<SpatialFrameId> for ReferenceFrameId

fn from(id: SpatialFrameId) -> ReferenceFrameId

Converts to this type from the input type.

impl Hash for SpatialFrameId

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

where H: Hasher,

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 PartialEq for SpatialFrameId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UniqueId for SpatialFrameId

fn new_unique() -> SpatialFrameId

New unique ID.

impl Copy for SpatialFrameId

impl Eq for SpatialFrameId

impl NoUninit for SpatialFrameId

impl PodInOption for SpatialFrameId

impl ZeroableInOption for SpatialFrameId