Struct rustc_middle::ty::CoroutineClosureSignature

pub struct CoroutineClosureSignature<'tcx> {
    pub interior: Ty<'tcx>,
    pub tupled_inputs_ty: Ty<'tcx>,
    pub resume_ty: Ty<'tcx>,
    pub yield_ty: Ty<'tcx>,
    pub return_ty: Ty<'tcx>,
    pub c_variadic: bool,
    pub unsafety: Unsafety,
    pub abi: Abi,
}

Fields

interior: Ty<'tcx>

tupled_inputs_ty: Ty<'tcx>

resume_ty: Ty<'tcx>

yield_ty: Ty<'tcx>

return_ty: Ty<'tcx>

c_variadic: bool

Always false

unsafety: Unsafety

Always hir::Unsafety::Normal

abi: Abi

Always abi::Abi::RustCall

Implementations

impl<'tcx> CoroutineClosureSignature<'tcx>

pub fn to_coroutine( self, tcx: TyCtxt<'tcx>, parent_args: &'tcx [GenericArg<'tcx>], coroutine_kind_ty: Ty<'tcx>, coroutine_def_id: DefId, tupled_upvars_ty: Ty<'tcx> ) -> Ty<'tcx>

Construct a coroutine from the closure signature. Since a coroutine signature is agnostic to the type of generator that is returned (by-ref/by-move), the caller must specify what “flavor” of generator that they’d like to create. Additionally, they must manually compute the upvars of the closure.

This helper is not really meant to be used directly except for early on during typeck, when we want to put inference vars into the kind and upvars tys. When the kind and upvars are known, use the other helper functions.

pub fn to_coroutine_given_kind_and_upvars( self, tcx: TyCtxt<'tcx>, parent_args: &'tcx [GenericArg<'tcx>], coroutine_def_id: DefId, goal_kind: ClosureKind, env_region: Region<'tcx>, closure_tupled_upvars_ty: Ty<'tcx>, coroutine_captures_by_ref_ty: Ty<'tcx> ) -> Ty<'tcx>

Given known upvars and a ClosureKind, compute the coroutine returned by that corresponding async fn trait.

This function expects the upvars to have been computed already, and doesn’t check that the ClosureKind is actually supported by the coroutine-closure.

pub fn tupled_upvars_by_closure_kind( tcx: TyCtxt<'tcx>, kind: ClosureKind, tupled_inputs_ty: Ty<'tcx>, closure_tupled_upvars_ty: Ty<'tcx>, coroutine_captures_by_ref_ty: Ty<'tcx>, env_region: Region<'tcx> ) -> Ty<'tcx>

Compute the tupled upvars that a coroutine-closure’s output coroutine would return for the given ClosureKind.

When ClosureKind is FnMut/Fn, then this will use the “captures by ref” to return a set of upvars which are borrowed with the given env_region.

This ensures that the AsyncFn::call will return a coroutine whose upvars’ lifetimes are related to the lifetime of the borrow on the closure made for the call. This allows borrowck to enforce the self-borrows correctly.

Trait Implementations

impl<'tcx> Clone for CoroutineClosureSignature<'tcx>

fn clone(&self) -> CoroutineClosureSignature<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for CoroutineClosureSignature<'tcx>

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

Formats the value using the given formatter.

impl<'tcx> PartialEq for CoroutineClosureSignature<'tcx>

fn eq(&self, other: &CoroutineClosureSignature<'tcx>) -> 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<'tcx> TypeFoldable<TyCtxt<'tcx>> for CoroutineClosureSignature<'tcx>

fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &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>(self, folder: &mut F) -> Self

where F: TypeFolder<I>,

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<TyCtxt<'tcx>> for CoroutineClosureSignature<'tcx>

fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V ) -> __V::Result

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

impl<'tcx> Copy for CoroutineClosureSignature<'tcx>

impl<'tcx> Eq for CoroutineClosureSignature<'tcx>

impl<'tcx> StructuralPartialEq for CoroutineClosureSignature<'tcx>

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: 48 bytes