Type Alias Const

pub type Const = Const<Interner>;

Aliased Type

struct Const { /* private fields */ }

Implementations

impl<I> Const<I>

where I: Interner,

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

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

pub fn interned(&self) -> &<I as Interner>::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 ConstExt for Const

fn is_unknown(&self) -> bool

Is a Const unknown?

impl HirDisplay for Const

fn hir_fmt(&self, f: &mut HirFormatter<'_>) -> Result<(), HirDisplayError>

fn into_displayable<'a>( &'a self, db: &'a dyn HirDatabase, max_size: Option<usize>, limited_size: Option<usize>, omit_verbose_types: bool, display_target: DisplayTarget, display_kind: DisplayKind, closure_style: ClosureStyle, show_container_bounds: bool, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable.

fn display<'a>( &'a self, db: &'a dyn HirDatabase, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable. Use this for showing types to the user (e.g. diagnostics)

fn display_truncated<'a>( &'a self, db: &'a dyn HirDatabase, max_size: Option<usize>, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to be succinct. Use this for showing types to the user where space is constrained (e.g. doc popups)

fn display_limited<'a>( &'a self, db: &'a dyn HirDatabase, limited_size: Option<usize>, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to limit the number of items inside. Use this for showing definitions which may contain too many items, like trait, struct, enum

fn display_source_code<'a>( &'a self, db: &'a dyn HirDatabase, module_id: ModuleId, allow_opaque: bool, ) -> Result<String, DisplaySourceCodeError>

Returns a String representation of self that can be inserted into the given module. Use this when generating code (e.g. assists)

fn display_test<'a>( &'a self, db: &'a dyn HirDatabase, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a String representation of self for test purposes

fn display_with_container_bounds<'a>( &'a self, db: &'a dyn HirDatabase, show_container_bounds: bool, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a String representation of self that shows the constraint from the container for functions

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

where I: Interner,

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

Cast a value to type T.

impl<I> Clone for Const<I>

where I: Clone + Interner, <I as Interner>::InternedConst: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Const<I>

where I: Interner,

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

Formats the value using the given formatter.

impl<I> HasInterner for Const<I>

where I: Interner,

type Interner = I

The interner associated with the type.

impl<I> Hash for Const<I>

where I: Hash + Interner, <I as Interner>::InternedConst: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> Ord for Const<I>

where I: Ord + Interner, <I as Interner>::InternedConst: Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<I> PartialEq for Const<I>

where I: PartialEq + Interner, <I as Interner>::InternedConst: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<I> PartialOrd for Const<I>

where I: PartialOrd + Interner, <I as Interner>::InternedConst: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<I> TypeFoldable<I> for Const<I>

where I: Interner,

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

fn try_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Const<I>, E>

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.

fn fold_with( self, folder: &mut dyn TypeFolder<I, Error = Infallible>, outer_binder: DebruijnIndex, ) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<I> TypeSuperFoldable<I> for Const<I>

where I: Interner,

fn try_super_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Const<I>, E>

Recursively folds the value.

fn super_fold_with( self, folder: &mut dyn TypeFolder<I, Error = Infallible>, outer_binder: DebruijnIndex, ) -> Self

A convenient alternative to try_super_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_super_fold_with.

impl<I> TypeSuperVisitable<I> for Const<I>

where I: Interner,

fn super_visit_with<B>( &self, visitor: &mut dyn TypeVisitor<I, BreakTy = B>, outer_binder: DebruijnIndex, ) -> ControlFlow<B>

Recursively visits the type contents.

impl<I> TypeVisitable<I> for Const<I>

where I: Interner,

fn visit_with<B>( &self, visitor: &mut dyn TypeVisitor<I, BreakTy = B>, outer_binder: DebruijnIndex, ) -> ControlFlow<B>

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

where I: Interner,

fn zip_with<Z>( zipper: &mut Z, variance: Variance, a: &Const<I>, b: &Const<I>, ) -> Result<(), NoSolution>

where Z: Zipper<I>,

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

impl<I> Copy for Const<I>

where I: Copy + Interner, <I as Interner>::InternedConst: Copy,

impl<I> Eq for Const<I>

where I: Eq + Interner, <I as Interner>::InternedConst: Eq,

impl<I> StructuralPartialEq for Const<I>

where I: Interner,