Type Alias Ty

pub type Ty = Ty<Interner>;

Aliased Type

struct Ty { /* private fields */ }

Implementations

impl<I> Ty<I>

where I: Interner,

pub fn new(interner: I, data: impl CastTo<TyKind<I>>) -> Ty<I>

Creates a type from TyKind.

pub fn interned(&self) -> &<I as Interner>::InternedType

Gets the interned type.

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

Gets the underlying type data.

pub fn kind(&self, interner: I) -> &TyKind<I>

Gets the underlying type kind.

pub fn from_env(&self) -> FromEnv<I>

Creates a FromEnv constraint using this type.

pub fn well_formed(&self) -> WellFormed<I>

Creates a WF-constraint for this type.

pub fn into_from_env_goal(self, interner: I) -> DomainGoal<I>

Creates a domain goal FromEnv(T) where T is this type.

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

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

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

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

pub fn is_general_var( &self, interner: I, binders: &CanonicalVarKinds<I>, ) -> bool

Returns true if this is a BoundVar or an InferenceVar of TyVariableKind::General.

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

Returns true if this is an Alias.

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

Returns true if this is an IntTy or UintTy.

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

Returns true if this is a FloatTy.

pub fn adt_id(&self, interner: I) -> Option<AdtId<I>>

Returns Some(adt_id) if this is an ADT, None otherwise

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

True if this type contains “bound” types/lifetimes, and hence needs to be shifted across binders. This is a very inefficient check, intended only for debug assertions, because I am lazy.

Trait Implementations

impl HirDisplay for Ty

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 TyExt for Ty

fn is_unit(&self) -> bool

fn is_integral(&self) -> bool

fn is_scalar(&self) -> bool

fn is_floating_point(&self) -> bool

fn is_never(&self) -> bool

fn is_str(&self) -> bool

fn is_unknown(&self) -> bool

fn contains_unknown(&self) -> bool

fn is_ty_var(&self) -> bool

fn is_union(&self) -> bool

fn as_adt(&self) -> Option<(AdtId, &Substitution)>

fn as_builtin(&self) -> Option<BuiltinType>

fn as_tuple(&self) -> Option<&Substitution>

fn as_closure(&self) -> Option<ClosureId>

fn as_fn_def(&self, db: &dyn HirDatabase) -> Option<FunctionId>

fn as_reference(&self) -> Option<(&Ty, Lifetime, Mutability)>

fn as_raw_ptr(&self) -> Option<(&Ty, Mutability)>

fn as_reference_or_ptr(&self) -> Option<(&Ty, Rawness, Mutability)>

fn as_generic_def(&self, db: &dyn HirDatabase) -> Option<GenericDefId>

fn callable_def(&self, db: &dyn HirDatabase) -> Option<CallableDefId>

fn callable_sig(&self, db: &dyn HirDatabase) -> Option<CallableSig>

fn dyn_trait(&self) -> Option<TraitId>

If this is a dyn Trait, returns that trait.

fn strip_references(&self) -> &Ty

fn strip_reference(&self) -> &Ty

fn impl_trait_bounds( &self, db: &dyn HirDatabase, ) -> Option<Vec<QuantifiedWhereClause>>

fn associated_type_parent_trait(&self, db: &dyn HirDatabase) -> Option<TraitId>

fn is_copy(self, db: &dyn HirDatabase, owner: DefWithBodyId) -> bool

fn equals_ctor(&self, other: &Ty) -> bool

FIXME: Get rid of this, it’s not a good abstraction

impl<I> CastTo<GenericArg<I>> for Ty<I>

where I: Interner,

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

Cast a value to type T.

impl<I> Clone for Ty<I>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Ty<I>

where I: Interner,

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

Formats the value using the given formatter.

impl<I> HasInterner for Ty<I>

where I: Interner,

type Interner = I

The interner associated with the type.

impl<I> Hash for Ty<I>

where I: Hash + Interner, <I as Interner>::InternedType: 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 Ty<I>

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

fn cmp(&self, other: &Ty<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 Ty<I>

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

fn eq(&self, other: &Ty<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 Ty<I>

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

fn partial_cmp(&self, other: &Ty<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 Ty<I>

where I: Interner,

“Folding” a type invokes the try_fold_ty method on the folder; this usually (in turn) invokes try_super_fold_ty to fold the individual parts.

fn try_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Ty<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 Ty<I>

where I: Interner,

“Super fold” for a type invokes te more detailed callbacks on the type

fn try_super_fold_with<E>( self, folder: &mut dyn FallibleTypeFolder<I, Error = E>, outer_binder: DebruijnIndex, ) -> Result<Ty<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 Ty<I>

where I: Interner,

“Super visit” for a type invokes the more detailed callbacks on the type

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 Ty<I>

where I: Interner,

“visiting” a type invokes the visit_ty method on the visitor; this usually (in turn) invokes super_visit_ty to visit the individual parts.

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 Ty<I>

where I: Interner,

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

where Z: Zipper<I>,

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

impl<I> Copy for Ty<I>

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

impl<I> Eq for Ty<I>

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

impl<I> StructuralPartialEq for Ty<I>

where I: Interner,