Enum rustc_middle::ty::ClosureKind

pub enum ClosureKind {
    Fn,
    FnMut,
    FnOnce,
}

Represents the various closure traits in the language. This will determine the type of the environment (self, in the desugaring) argument that the closure expects.

You can get the environment type of a closure using tcx.closure_env_ty().

Variants

Fn

FnMut

FnOnce

Implementations

impl<'tcx> ClosureKind

pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn

This is the initial value used when doing upvar inference.

pub fn extends(self, other: ClosureKind) -> bool

Returns true if a type that impls this closure kind must also implement other.

pub fn to_def_id(&self, tcx: TyCtxt<'_>) -> DefId

Converts self to a DefId of the corresponding trait.

Note: the inverse of this function is TyCtxt::fn_trait_kind_from_def_id.

pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>

Returns the representative scalar type for this closure kind. See Ty::to_opt_closure_kind for more details.

Trait Implementations

impl Clone for ClosureKind

fn clone(&self) -> ClosureKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClosureKind

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for ClosureKind

fn decode(__decoder: &mut __D) -> Self

impl<'tcx> Display for ClosureKind

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

Formats the value using the given formatter.

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for ClosureKind

fn encode(&self, __encoder: &mut __E)

impl Hash for ClosureKind

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'__ctx> HashStable<StableHashingContext<'__ctx>> for ClosureKind

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> Lift<'tcx> for ClosureKind

type Lifted = ClosureKind

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

impl Ord for ClosureKind

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ClosureKind> for ClosureKind

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

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

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

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

impl PartialOrd<ClosureKind> for ClosureKind

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

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

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

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

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

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

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

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

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 ClosureKind

type Output = P

type Error = Error

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

impl<'tcx> TypeFoldable<'tcx> for ClosureKind

fn try_fold_with<F: FallibleTypeFolder<'tcx>>(
    self,
    _: &mut F
) -> Result<Self, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<'tcx>>(self, _: &mut F) -> 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<'tcx> TypeVisitable<'tcx> for ClosureKind

fn visit_with<F: TypeVisitor<'tcx>>(&self, _: &mut F) -> ControlFlow<F::BreakTy>

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

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.

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

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

fn has_escaping_bound_vars(&self) -> bool

Return true if this type has regions that are not a part of the type. For example, for<'a> fn(&'a i32) return false, while fn(&'a i32) would return true. The latter can occur when traversing through the former.

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

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Result<(), ErrorGuaranteed>

fn has_non_region_param(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_non_region_infer(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

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.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

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.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

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.

impl Copy for ClosureKind

impl Eq for ClosureKind

impl StructuralEq for ClosureKind

impl StructuralPartialEq for ClosureKind

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• Fn: 0 bytes
• FnMut: 0 bytes
• FnOnce: 0 bytes