Struct salsa_2022::id::Id

pub struct Id { /* private fields */ }

An Id is a newtype’d u32 ranging from 0..Id::MAX_U32. The maximum range is smaller than a standard u32 to leave room for niches; currently there is only one niche, so that Option<Id> is the same size as an Id.

You will rarely use the Id type directly, though you can. You are more likely to use types that implement the AsId trait, such as entity keys.

Implementations

impl Id

pub const MAX_U32: u32 = 4_294_967_040u32

pub const MAX_USIZE: usize = 4_294_967_040usize

pub fn from_u32(x: u32) -> Self

Create a salsa::Id from a u32 value. This value should be less than Self::MAX_U32.

In general, you should not need to create salsa ids yourself, but it can be useful if you are using the type as a general purpose “identifier” internally.

pub fn as_u32(self) -> u32

Trait Implementations

impl AsId for Id

fn as_id(self) -> Id

fn from_id(id: Id) -> Self

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl From<Id> for u32

fn from(n: Id) -> Self

Converts to this type from the input type.

impl From<Id> for usize

fn from(n: Id) -> usize

Converts to this type from the input type.

impl From<u32> for Id

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<usize> for Id

fn from(n: usize) -> Self

Converts to this type from the input type.

impl Hash for Id

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,

Feeds a slice of this type into the given Hasher.

impl Ord for Id

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Id> for Id

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Id> for Id

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Id

impl Eq for Id

impl StructuralEq for Id

impl StructuralPartialEq for Id