Struct EntityId 

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

A stable identity for a topological entity, valid for the lifetime of a document.

Distinct from an arena Key: a key says where the data is and dies when the entity is rebuilt; an EntityId says what the entity is and survives.

Implementations

impl EntityId

pub const fn get(self) -> u64

The identity’s raw value. Non-zero.

pub const fn from_raw(raw: u64) -> Option<Self>

An identity from a raw value, or None if it is zero.

For reading a document back from a file, which has to reproduce the identities it was written with: a reference recorded against EntityId(7) has to still find entity seven. Nothing else should mint one of these: within a document, ProvenanceTable::record is what issues an identity, and it issues one that has something behind it.

Trait Implementations

impl Clone for EntityId

fn clone(&self) -> EntityId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EntityId

impl Debug for EntityId

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

Formats the value using the given formatter.

impl Eq for EntityId

impl Hash for EntityId

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 EntityId

fn cmp(&self, other: &EntityId) -> 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.

impl PartialEq for EntityId

fn eq(&self, other: &EntityId) -> 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 PartialOrd for EntityId

fn partial_cmp(&self, other: &EntityId) -> 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 EntityId