Struct chalk_ir::Const

pub struct Const<I: Interner> { /* fields omitted */ }

Constants.

Implementations

impl<I: Interner> Const<I>

pub fn new(interner: &I, data: impl CastTo<ConstData<I>>) -> Self

Create a Const using something that can be cast to const data.

pub fn interned(&self) -> &I::InternedConst

Gets the interned constant.

pub fn data(&self, interner: &I) -> &ConstData<I>

Gets the constant data from the interner.

pub fn bound_var(&self, interner: &I) -> Option<BoundVar>

If this is a ConstData::BoundVar(d), returns Some(d) else None.

pub fn inference_var(&self, interner: &I) -> Option<InferenceVar>

If this is a ConstData::InferenceVar(d), returns Some(d) else None.

pub fn needs_shift(&self, interner: &I) -> bool

True if this const is a "bound" const, and hence needs to be shifted across binders. Meant for debug assertions.

Trait Implementations

impl<I: Interner> CastTo<GenericArg<I>> for Const<I>

pub fn cast_to(self, interner: &I) -> GenericArg<I>

Cast a value to type T.

impl<I: Clone + Interner> Clone for Const<I> where
    I::InternedConst: Clone, 

pub fn clone(&self) -> Const<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Copy + Interner> Copy for Const<I> where
    I::InternedConst: Copy, 

impl<I: Interner> Debug for Const<I>

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

Formats the value using the given formatter.

impl<I: Eq + Interner> Eq for Const<I> where
    I::InternedConst: Eq, 

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

"Folding" a const invokes the fold_const method on the folder; this usually (in turn) invokes super_fold_const to fold the individual parts.

type Result = Const<I>

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

pub 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<I: Interner> HasInterner for Const<I>

type Interner = I

The interner associated with the type.

impl<I: Hash + Interner> Hash for Const<I> where
    I::InternedConst: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<I: Ord + Interner> Ord for Const<I> where
    I::InternedConst: Ord, 

pub fn cmp(&self, other: &Const<I>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<I: PartialEq + Interner> PartialEq<Const<I>> for Const<I> where
    I::InternedConst: PartialEq, 

pub fn eq(&self, other: &Const<I>) -> bool

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

pub fn ne(&self, other: &Const<I>) -> bool

This method tests for !=.

impl<I: PartialOrd + Interner> PartialOrd<Const<I>> for Const<I> where
    I::InternedConst: PartialOrd, 

pub fn partial_cmp(&self, other: &Const<I>) -> Option<Ordering>

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

pub fn lt(&self, other: &Const<I>) -> bool

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

pub fn le(&self, other: &Const<I>) -> bool

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

pub fn gt(&self, other: &Const<I>) -> bool

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

pub fn ge(&self, other: &Const<I>) -> bool

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

impl<I: Interner> StructuralEq for Const<I>

impl<I: Interner> StructuralPartialEq for Const<I>

impl<I> SuperFold<I> for Const<I> where
    I: Interner, 

pub fn super_fold_with<'i>(
    &self,
    folder: &mut dyn Folder<'i, I>,
    outer_binder: DebruijnIndex
) -> Fallible<Const<I>> where
    I: 'i, 

Recursively folds the value.

impl<I: Interner> SuperVisit<I> for Const<I>

pub fn super_visit_with<'i, B>(
    &self,
    visitor: &mut dyn Visitor<'i, I, BreakTy = B>,
    outer_binder: DebruijnIndex
) -> ControlFlow<B> where
    I: 'i, 

Recursively visits the type contents.

impl<I: Interner> Visit<I> for Const<I>

pub 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<I: Interner> Zip<I> for Const<I>

pub fn zip_with<'i, Z: Zipper<'i, I>>(
    zipper: &mut Z,
    variance: Variance,
    a: &Self,
    b: &Self
) -> Fallible<()> where
    I: 'i, 

Uses the zipper to walk through two values, ensuring that they match.