Struct chalk_ir::UniverseIndex

pub struct UniverseIndex {
    pub counter: usize,
}

An universe index is how a universally quantified parameter is represented when it’s binder is moved into the environment. An example chain of transformations would be: forall<T> { Goal(T) } (syntactical representation) forall { Goal(?0) } (used a DeBruijn index) Goal(!U1) (the quantifier was moved to the environment and replaced with a universe index) See https://rustc-dev-guide.rust-lang.org/borrow_check/region_inference.html#placeholders-and-universes for more.

Fields

counter: usize

The counter for the universe index, starts with 0.

Implementations

impl UniverseIndex

pub const ROOT: UniverseIndex

Root universe index (0).

pub fn root() -> UniverseIndex

Root universe index (0).

pub fn can_see(self, ui: UniverseIndex) -> bool

Whether one universe can “see” another.

pub fn next(self) -> UniverseIndex

Increases the index counter.

Trait Implementations

impl Clone for UniverseIndex

fn clone(&self) -> UniverseIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UniverseIndex

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

Formats the value using the given formatter.

impl Display for UniverseIndex

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

Formats the value using the given formatter.

impl<I: Interner> Fold<I> for UniverseIndex

type Result = Self

The type of value that will be produced once folding is done. Typically this is Self, unless Self contains borrowed values, in which case owned values are produced (for example, one can fold over a &T value where T: Fold, in which case you get back a T, not a &T).

fn fold_with<'i>(
    self,
    _folder: &mut dyn Folder<'i, I>,
    _outer_binder: DebruijnIndex
) -> Fallible<Self::Result> where
    I: 'i, 

Apply the given folder folder to self; binders is the number of binders that are in scope when beginning the folder. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

impl Hash for UniverseIndex

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 UniverseIndex

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<UniverseIndex> for UniverseIndex

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

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

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

This method tests for !=.

impl PartialOrd<UniverseIndex> for UniverseIndex

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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<I: Interner> Visit<I> for UniverseIndex

fn visit_with<'i, B>(
    &self,
    _visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    _outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

Apply the given visitor visitor to self; binders is the number of binders that are in scope when beginning the visitor. Typically binders starts as 0, but is adjusted when we encounter Binders<T> in the IR or other similar constructs.

impl Copy for UniverseIndex

impl Eq for UniverseIndex

impl StructuralEq for UniverseIndex

impl StructuralPartialEq for UniverseIndex