pub struct UniverseIndex {
    pub(crate) private: u32,
}
Expand description

“Universes” are used during type- and trait-checking in the presence of for<..> binders to control what sets of names are visible. Universes are arranged into a tree: the root universe contains names that are always visible. Each child then adds a new set of names that are visible, in addition to those of its parent. We say that the child universe “extends” the parent universe with new names.

To make this more concrete, consider this program:

struct Foo { }
fn bar<T>(x: T) {
  let y: for<'a> fn(&'a u8, Foo) = ...;
}

The struct name Foo is in the root universe U0. But the type parameter T, introduced on bar, is in an extended universe U1 – i.e., within bar, we can name both T and Foo, but outside of bar, we cannot name T. Then, within the type of y, the region 'a is in a universe U2 that extends U1, because we can name it inside the fn type but not outside.

Universes are used to do type- and trait-checking around these “forall” binders (also called universal quantification). The idea is that when, in the body of bar, we refer to T as a type, we aren’t referring to any type in particular, but rather a kind of “fresh” type that is distinct from all other types we have actually declared. This is called a placeholder type, and we use universes to talk about this. In other words, a type name in universe 0 always corresponds to some “ground” type that the user declared, but a type name in a non-zero universe is a placeholder type – an idealized representative of “types in general” that we use for checking generic functions.

Fields§

§private: u32

Implementations§

source§

impl UniverseIndex

source

pub const MAX_AS_U32: u32 = 4_294_967_040u32

Maximum value the index can take, as a u32.

source

pub const MAX: Self = _

Maximum value the index can take.

source

pub const fn from_usize(value: usize) -> Self

Creates a new index from a given usize.

Panics

Will panic if value exceeds MAX.

source

pub const fn from_u32(value: u32) -> Self

Creates a new index from a given u32.

Panics

Will panic if value exceeds MAX.

source

pub const unsafe fn from_u32_unchecked(value: u32) -> Self

Creates a new index from a given u32.

Safety

The provided value must be less than or equal to the maximum value for the newtype. Providing a value outside this range is undefined due to layout restrictions.

Prefer using from_u32.

source

pub const fn index(self) -> usize

Extracts the value of this index as a usize.

source

pub const fn as_u32(self) -> u32

Extracts the value of this index as a u32.

source

pub const fn as_usize(self) -> usize

Extracts the value of this index as a usize.

source§

impl UniverseIndex

source

pub const ROOT: UniverseIndex = _

source

pub fn next_universe(self) -> UniverseIndex

Returns the “next” universe index in order – this new index is considered to extend all previous universes. This corresponds to entering a forall quantifier. So, for example, suppose we have this type in universe U:

for<'a> fn(&'a u32)

Once we “enter” into this for<'a> quantifier, we are in a new universe that extends U – in this new universe, we can name the region 'a, but that region was not nameable from U because it was not in scope there.

source

pub fn can_name(self, other: UniverseIndex) -> bool

Returns true if self can name a name from other – in other words, if the set of names in self is a superset of those in other (self >= other).

source

pub fn cannot_name(self, other: UniverseIndex) -> bool

Returns true if self cannot name some names from other – in other words, if the set of names in self is a strict subset of those in other (self < other).

Trait Implementations§

source§

impl Add<usize> for UniverseIndex

§

type Output = UniverseIndex

The resulting type after applying the + operator.
source§

fn add(self, other: usize) -> Self

Performs the + operation. Read more
source§

impl Clone for UniverseIndex

source§

fn clone(&self) -> UniverseIndex

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for UniverseIndex

source§

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

Formats the value using the given formatter. Read more
source§

impl<D: Decoder> Decodable<D> for UniverseIndex

source§

fn decode(d: &mut D) -> Self

source§

impl<E: Encoder> Encodable<E> for UniverseIndex

source§

fn encode(&self, e: &mut E)

source§

impl From<UniverseIndex> for u32

source§

fn from(v: UniverseIndex) -> u32

Converts to this type from the input type.
source§

impl From<UniverseIndex> for usize

source§

fn from(v: UniverseIndex) -> usize

Converts to this type from the input type.
source§

impl From<u32> for UniverseIndex

source§

fn from(value: u32) -> Self

Converts to this type from the input type.
source§

impl From<usize> for UniverseIndex

source§

fn from(value: usize) -> Self

Converts to this type from the input type.
source§

impl Hash for UniverseIndex

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<__CTX> HashStable<__CTX> for UniverseIndexwhere __CTX: HashStableContext,

source§

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

source§

impl Idx for UniverseIndex

source§

fn new(value: usize) -> Self

source§

fn index(self) -> usize

§

fn increment_by(&mut self, amount: usize)

§

fn plus(self, amount: usize) -> Self

source§

impl Ord for UniverseIndex

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<UniverseIndex> for UniverseIndex

source§

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

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

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.
source§

impl PartialOrd<UniverseIndex> for UniverseIndex

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Step for UniverseIndex

source§

fn steps_between(start: &Self, end: &Self) -> Option<usize>

🔬This is a nightly-only experimental API. (step_trait)
Returns the number of successor steps required to get from start to end. Read more
source§

fn forward_checked(start: Self, u: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the successor of self count times. Read more
source§

fn backward_checked(start: Self, u: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the predecessor of self count times. Read more
source§

fn forward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the successor of self count times. Read more
source§

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the successor of self count times. Read more
source§

fn backward(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the predecessor of self count times. Read more
source§

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait)
Returns the value that would be obtained by taking the predecessor of self count times. Read more
source§

impl Copy for UniverseIndex

source§

impl Eq for UniverseIndex

source§

impl StructuralEq for UniverseIndex

source§

impl StructuralPartialEq for UniverseIndex

source§

impl TrustedStep for UniverseIndex

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, R> CollectAndApply<T, R> for T

source§

fn collect_and_apply<I, F>(iter: I, f: F) -> Rwhere I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes