Struct rustc_middle::ty::subst::GenericArg

pub struct GenericArg<'tcx> {
    ptr: NonZeroUsize,
    marker: PhantomData<(Ty<'tcx>, Region<'tcx>, &'tcx Const<'tcx>)>,
}

An entity in the Rust type system, which can be one of several kinds (types, lifetimes, and consts). To reduce memory usage, a GenericArg is a interned pointer, with the lowest 2 bits being reserved for a tag to indicate the type (Ty, Region, or Const) it points to.

Fields

ptr: NonZeroUsize

marker: PhantomData<(Ty<'tcx>, Region<'tcx>, &'tcx Const<'tcx>)>

Implementations

impl<'tcx> GenericArg<'tcx>

pub fn unpack(self) -> GenericArgKind<'tcx>

pub fn expect_ty(self) -> Ty<'tcx>

Unpack the GenericArg as a type when it is known certainly to be a type. This is true in cases where Substs is used in places where the kinds are known to be limited (e.g. in tuples, where the only parameters are type parameters).

pub fn expect_const(self) -> &'tcx Const<'tcx>

Unpack the GenericArg as a const when it is known certainly to be a const.

impl<'tcx> GenericArg<'tcx>

pub fn walk(self) -> TypeWalker<'tcx>

Iterator that walks self and any types reachable from self, in depth-first order. Note that just walks the types that appear in self, it does not descend into the fields of structs or variants. For example:

isize => { isize }
Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
[isize] => { [isize], isize }

pub fn walk_shallow(
    self,
    visited: &mut SsoHashSet<GenericArg<'tcx>>
) -> impl Iterator<Item = GenericArg<'tcx>>

Iterator that walks the immediate children of self. Hence Foo<Bar<i32>, u32> yields the sequence [Bar<i32>, u32] (but not i32, like walk).

Iterator only walks items once. It accepts visited set, updates it with all visited types and skips any types that are already there.

Trait Implementations

impl<'tcx> Clone for GenericArg<'tcx>

pub fn clone(&self) -> GenericArg<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Copy for GenericArg<'tcx>

impl<'tcx> Debug for GenericArg<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for GenericArg<'tcx>

pub fn decode(d: &mut D) -> Result<GenericArg<'tcx>, D::Error>

impl<'tcx> Display for GenericArg<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for GenericArg<'tcx>

pub fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl<'tcx> Eq for GenericArg<'tcx>

impl<'tcx> From<&'tcx Const<'tcx>> for GenericArg<'tcx>

pub fn from(c: &'tcx Const<'tcx>) -> GenericArg<'tcx>

Performs the conversion.

impl<'tcx> From<&'tcx RegionKind> for GenericArg<'tcx>

pub fn from(r: Region<'tcx>) -> GenericArg<'tcx>

Performs the conversion.

impl<'tcx> From<&'tcx TyS<'tcx>> for GenericArg<'tcx>

pub fn from(ty: Ty<'tcx>) -> GenericArg<'tcx>

Performs the conversion.

impl<'tcx> Hash for GenericArg<'tcx>

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<'a, 'tcx> HashStable<StableHashingContext<'a>> for GenericArg<'tcx>

pub fn hash_stable(
    &self,
    hcx: &mut StableHashingContext<'a>,
    hasher: &mut StableHasher
)

impl<'tcx> Key for GenericArg<'tcx>

type CacheSelector = DefaultCacheSelector

pub fn query_crate(&self) -> CrateNum

Given an instance of this key, what crate is it referring to? This is used to find the provider.

pub fn default_span(&self, _: TyCtxt<'_>) -> Span

In the event that a cycle occurs, if no explicit span has been given for a query with key self, what span should we use?

impl<'a, 'tcx> Lift<'tcx> for GenericArg<'a>

type Lifted = GenericArg<'tcx>

pub fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>

impl<'tcx> Ord for GenericArg<'tcx>

pub fn cmp(&self, other: &GenericArg<'_>) -> 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<'tcx> PartialEq<GenericArg<'tcx>> for GenericArg<'tcx>

pub fn eq(&self, other: &GenericArg<'tcx>) -> bool

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

pub fn ne(&self, other: &GenericArg<'tcx>) -> bool

This method tests for !=.

impl<'tcx> PartialOrd<GenericArg<'tcx>> for GenericArg<'tcx>

pub fn partial_cmp(&self, other: &GenericArg<'_>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<'tcx, P: PrettyPrinter<'tcx>> Print<'tcx, P> for GenericArg<'tcx>

type Output = P

type Error = Error

pub fn print(&self, cx: P) -> Result<Self::Output, Self::Error>

impl<'tcx> Relate<'tcx> for GenericArg<'tcx>

pub fn relate<R: TypeRelation<'tcx>>(
    relation: &mut R,
    a: GenericArg<'tcx>,
    b: GenericArg<'tcx>
) -> RelateResult<'tcx, GenericArg<'tcx>>

impl<'tcx> StructuralEq for GenericArg<'tcx>

impl<'tcx> StructuralPartialEq for GenericArg<'tcx>

impl<'tcx> TypeFoldable<'tcx> for GenericArg<'tcx>

pub fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

pub fn super_visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

pub fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

pub fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

pub fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

pub fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

pub fn has_escaping_bound_vars(&self) -> bool

pub fn has_type_flags(&self, flags: TypeFlags) -> bool

pub fn has_projections(&self) -> bool

pub fn has_opaque_types(&self) -> bool

pub fn references_error(&self) -> bool

pub fn has_param_types_or_consts(&self) -> bool

pub fn has_infer_regions(&self) -> bool

pub fn has_infer_types(&self) -> bool

pub fn has_infer_types_or_consts(&self) -> bool

pub fn needs_infer(&self) -> bool

pub fn has_placeholders(&self) -> bool

pub fn needs_subst(&self) -> bool

pub fn has_free_regions(&self) -> bool

"Free" regions in this context means that it has any region that is not (a) erased or (b) late-bound.

pub fn has_erased_regions(&self) -> bool

pub fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

pub fn is_global(&self) -> bool

Indicates whether this value references only 'global' generic parameters that are the same regardless of what fn we are in. This is used for caching.

pub fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

pub fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.