Struct salsa::InternId

pub struct InternId { /* fields omitted */ }

The "raw-id" is used for interned keys in salsa -- it is basically a newtype'd u32. Typically, it is wrapped in a type of your own devising. For more information about interned keys, see the interned key RFC.

Creating a InternId

InternId values can be constructed using the From impls, which are implemented for u32 and usize:

let intern_id1 = InternId::from(22_u32);
let intern_id2 = InternId::from(22_usize);
assert_eq!(intern_id1, intern_id2);

Converting to a u32 or usize

Normally, there should be no need to access the underlying integer in a InternId. But if you do need to do so, you can convert to a usize using the as_u32 or as_usize methods or the From impls.

let intern_id = InternId::from(22_u32);
let value = u32::from(intern_id);
assert_eq!(value, 22);

Illegal values

Be warned, however, that InternId values cannot be created from arbitrary values -- in particular large values greater than InternId::MAX will panic. Those large values are reserved so that the Rust compiler can use them as sentinel values, which means that (for example) Option<InternId> is represented in a single word.

InternId::from(InternId::MAX);

Methods

impl InternId

pub const MAX: u32

The maximum allowed InternId. This value can grow between releases without affecting semver.

pub fn as_u32(self) -> u32

Convert this raw-id into a u32 value.

let intern_id = InternId::from(22_u32);
let value = intern_id.as_usize();
assert_eq!(value, 22);

pub fn as_usize(self) -> usize

Convert this raw-id into a usize value.

let intern_id = InternId::from(22_u32);
let value = intern_id.as_usize();
assert_eq!(value, 22);

Trait Implementations

impl InternKey for InternId

fn from_intern_id(v: InternId) -> InternId

Create an instance of the intern-key from a u32 value.

fn as_intern_id(&self) -> InternId

Extract the u32 with which the intern-key was created.

impl Eq for InternId

impl Ord for InternId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<InternId> for InternId

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

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

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

This method tests for !=.

impl Copy for InternId

impl Clone for InternId

fn clone(&self) -> InternId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<InternId> for InternId

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

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

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

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

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

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

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

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

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

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

impl From<InternId> for u32

fn from(raw: InternId) -> u32

Performs the conversion.

impl From<InternId> for usize

fn from(raw: InternId) -> usize

Performs the conversion.

impl From<u32> for InternId

fn from(id: u32) -> InternId

Performs the conversion.

impl From<usize> for InternId

fn from(id: usize) -> InternId

Performs the conversion.

impl Debug for InternId

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

Formats the value using the given formatter.

impl Display for InternId

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

Formats the value using the given formatter.

impl Hash for InternId

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].