CoroutineClosureSignature in rustc_type_ir::ty_kind::closure - Rust
Description: API documentation for the Rust `CoroutineClosureSignature` struct in crate `rustc_type_ir`.

Skip to main content

## CoroutineClosureSignature

# Struct CoroutineClosureSignature

Source

    pub struct CoroutineClosureSignature<I: Interner> {
        pub tupled_inputs_ty: I::Ty,
        pub resume_ty: I::Ty,
        pub yield_ty: I::Ty,
        pub return_ty: I::Ty,
        pub c_variadic: bool,
        pub safety: I::Safety,
        pub abi: I::Abi,
    }

## Fields§

§`tupled_inputs_ty: I::Ty`§`resume_ty: I::Ty`§`yield_ty: I::Ty`§`return_ty: I::Ty`§`c_variadic: bool`

Always false

§`safety: I::Safety`

Always `Normal` (safe)

§`abi: I::Abi`

Always `RustCall`

## Implementations§

Source§

### impl<I: Interner> CoroutineClosureSignature<I>

Source

#### pub fn to_coroutine( self, cx: I, parent_args: I::GenericArgsSlice, coroutine_kind_ty: I::Ty, coroutine_def_id: I::CoroutineId, tupled_upvars_ty: I::Ty, ) -> I::Ty

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.

Source

#### pub fn to_coroutine_given_kind_and_upvars( self, cx: I, parent_args: I::GenericArgsSlice, coroutine_def_id: I::CoroutineId, goal_kind: ClosureKind, env_region: I::Region, closure_tupled_upvars_ty: I::Ty, coroutine_captures_by_ref_ty: I::Ty, ) -> I::Ty

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.

Source

#### pub fn tupled_upvars_by_closure_kind( cx: I, kind: ClosureKind, tupled_inputs_ty: I::Ty, closure_tupled_upvars_ty: I::Ty, coroutine_captures_by_ref_ty: I::Ty, env_region: I::Region, ) -> I::Ty

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§

Source§

### impl<I> Clone for CoroutineClosureSignature<I>
where I: Interner,

Source§

#### fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl<I> Debug for CoroutineClosureSignature<I>
where I: Interner,

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<I> Hash for CoroutineClosureSignature<I>
where I: Interner,

Source§

#### fn hash<__H: Hasher>(&self, __state: &mut __H)

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
Source§

### impl<I> PartialEq for CoroutineClosureSignature<I>
where I: Interner,

Source§

#### fn eq(&self, __other: &Self) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl<I> TypeFoldable<I> for CoroutineClosureSignature<I>
where I: Interner, I::Ty: TypeFoldable<I>,

Source§

#### fn try_fold_with<__F: FallibleTypeFolder<I>>( 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)`. Read more
Source§

#### fn fold_with<__F: TypeFolder<I>>(self, __folder: &mut __F) -> Self

The entry point for folding. To fold a value `t` with a folder `f` call: `t.fold_with(f)`. Read more
Source§

### impl<I> TypeVisitable<I> for CoroutineClosureSignature<I>
where I: Interner, I::Ty: TypeVisitable<I>,

Source§

#### fn visit_with<__V: TypeVisitor<I>>(&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)`. Read more
Source§

### impl<I> Copy for CoroutineClosureSignature<I>
where I: Interner,

Source§

### impl<I: Interner> Eq for CoroutineClosureSignature<I>

## Auto Trait Implementations§

§

### impl<I> DynSend for CoroutineClosureSignature<I>
where <I as Interner>::Ty: DynSend, <I as Interner>::Safety: DynSend, <I as Interner>::Abi: DynSend,

§

### impl<I> DynSync for CoroutineClosureSignature<I>
where <I as Interner>::Ty: DynSync, <I as Interner>::Safety: DynSync, <I as Interner>::Abi: DynSync,

§

### impl<I> Freeze for CoroutineClosureSignature<I>
where <I as Interner>::Ty: Freeze, <I as Interner>::Safety: Freeze, <I as Interner>::Abi: Freeze,

§

### impl<I> RefUnwindSafe for CoroutineClosureSignature<I>
where <I as Interner>::Ty: RefUnwindSafe, <I as Interner>::Safety: RefUnwindSafe, <I as Interner>::Abi: RefUnwindSafe,

§

### impl<I> Send for CoroutineClosureSignature<I>
where <I as Interner>::Ty: Send, <I as Interner>::Safety: Send, <I as Interner>::Abi: Send,

§

### impl<I> Sync for CoroutineClosureSignature<I>
where <I as Interner>::Ty: Sync, <I as Interner>::Safety: Sync, <I as Interner>::Abi: Sync,

§

### impl<I> Unpin for CoroutineClosureSignature<I>
where <I as Interner>::Ty: Unpin, <I as Interner>::Safety: Unpin, <I as Interner>::Abi: Unpin,

§

### impl<I> UnsafeUnpin for CoroutineClosureSignature<I>
where <I as Interner>::Ty: UnsafeUnpin, <I as Interner>::Safety: UnsafeUnpin, <I as Interner>::Abi: UnsafeUnpin,

§

### impl<I> UnwindSafe for CoroutineClosureSignature<I>
where <I as Interner>::Ty: UnwindSafe, <I as Interner>::Safety: UnwindSafe, <I as Interner>::Abi: UnwindSafe,

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

#### fn as_any(&self) -> &(dyn Any + 'static)

Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T> TypeVisitableExt<I> for T
where I: Interner, T: TypeVisitable<I>,

Source§

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

Source§

#### 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.
Source§

#### fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>

Source§

#### fn non_region_error_reported( &self, ) -> Result<(), <I as Interner>::ErrorGuaranteed>

Source§

#### 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).
Source§

#### 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. Read more
Source§

#### fn has_aliases(&self) -> bool

Source§

#### fn has_opaque_types(&self) -> bool

Source§

#### fn has_coroutines(&self) -> bool

Source§

#### fn references_error(&self) -> bool

Source§

#### fn has_non_region_param(&self) -> bool

Source§

#### fn has_infer_regions(&self) -> bool

Source§

#### fn has_infer_types(&self) -> bool

Source§

#### fn has_non_region_infer(&self) -> bool

Source§

#### fn has_infer(&self) -> bool

Source§

#### fn has_placeholders(&self) -> bool

Source§

#### fn has_non_region_placeholders(&self) -> bool

Source§

#### fn has_param(&self) -> bool

Source§

#### 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.
Source§

#### fn has_erased_regions(&self) -> bool

Source§

#### fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
Source§

#### 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.
Source§

#### fn has_bound_regions(&self) -> bool

True if there are any late-bound regions
Source§

#### fn has_non_region_bound_vars(&self) -> bool

True if there are any late-bound non-region variables
Source§

#### fn has_bound_vars(&self) -> bool

True if there are any bound variables
Source§

#### 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.
Source§

#### fn has_non_region_error(&self) -> bool

True if a type or const error is reachable
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.