Struct EntityId

pub struct EntityId<E: Entity>(/* private fields */);

An Id that is scoped to an Entity.

This is useful, as it allows limiting the semantic meaning of an Id. As such it can be used to maintain provenance information of Ids.

Note

The only safe way to obtain a EntityId is via the Replica::get_* functions.

Implementations

impl<E: Entity> EntityId<E>

pub unsafe fn from_id(value: Id) -> Self

Convert an raw Id to an EntityId for an specific Entity.

Safety

The Id should be valid for the specified Entity.

pub fn as_id(&self) -> Id

Return the underlying Id.

pub fn to_ref_path(&self) -> String

Get the git reference path of this EntityId.

Trait Implementations

impl<E: Entity> Clone for EntityId<E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Entity> Debug for EntityId<E>

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

Formats the value using the given formatter.

impl<'de, E: Entity> Deserialize<'de> for EntityId<E>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: Entity> Display for EntityId<E>

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

Formats the value using the given formatter.

impl<E: Entity> Ord for EntityId<E>

fn cmp(&self, other: &Self) -> 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<E: Entity> PartialEq for EntityId<E>

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

fn partial_cmp(&self, other: &Self) -> 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<E: Entity> Serialize for EntityId<E>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<E: Entity> Copy for EntityId<E>

impl<E: Entity> Eq for EntityId<E>