Struct rustc_middle::ty::CoroutineArgs
source · pub struct CoroutineArgs<I>where
I: Interner,{
pub args: <I as Interner>::GenericArgs,
}
Expand description
Similar to ClosureArgs
; see the above documentation for more.
Fields§
§args: <I as Interner>::GenericArgs
Implementations§
source§impl<I> CoroutineArgs<I>where
I: Interner,
impl<I> CoroutineArgs<I>where
I: Interner,
sourcepub fn new(cx: I, parts: CoroutineArgsParts<I>) -> CoroutineArgs<I>
pub fn new(cx: I, parts: CoroutineArgsParts<I>) -> CoroutineArgs<I>
Construct CoroutineArgs
from CoroutineArgsParts
, containing Args
for the coroutine parent, alongside additional coroutine-specific components.
sourcepub fn parent_args(self) -> <I as Interner>::GenericArgsSlice
pub fn parent_args(self) -> <I as Interner>::GenericArgsSlice
Returns the generic parameters of the coroutine’s parent.
pub fn kind_ty(self) -> <I as Interner>::Ty
sourcepub fn witness(self) -> <I as Interner>::Ty
pub fn witness(self) -> <I as Interner>::Ty
This describes the types that can be contained in a coroutine. It will be a type variable initially and unified in the last stages of typeck of a body. It contains a tuple of all the types that could end up on a coroutine frame. The state transformation MIR pass may only produce layouts which mention types in this tuple. Upvars are not counted here.
sourcepub fn upvar_tys(self) -> <I as Interner>::Tys
pub fn upvar_tys(self) -> <I as Interner>::Tys
Returns an iterator over the list of types of captured paths by the coroutine. In case there was a type error in figuring out the types of the captured path, an empty iterator is returned.
sourcepub fn tupled_upvars_ty(self) -> <I as Interner>::Ty
pub fn tupled_upvars_ty(self) -> <I as Interner>::Ty
Returns the tuple type representing the upvars for this coroutine.
sourcepub fn resume_ty(self) -> <I as Interner>::Ty
pub fn resume_ty(self) -> <I as Interner>::Ty
Returns the type representing the resume type of the coroutine.
sourcepub fn yield_ty(self) -> <I as Interner>::Ty
pub fn yield_ty(self) -> <I as Interner>::Ty
Returns the type representing the yield type of the coroutine.
Trait Implementations§
source§impl<I> Clone for CoroutineArgs<I>where
I: Interner,
impl<I> Clone for CoroutineArgs<I>where
I: Interner,
source§fn clone(&self) -> CoroutineArgs<I>
fn clone(&self) -> CoroutineArgs<I>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'tcx> CoroutineArgsExt<'tcx> for CoroutineArgs<TyCtxt<'tcx>>
impl<'tcx> CoroutineArgsExt<'tcx> for CoroutineArgs<TyCtxt<'tcx>>
source§const RESERVED_VARIANTS: usize = 3usize
const RESERVED_VARIANTS: usize = 3usize
Number of variants to reserve in coroutine state. Corresponds to
UNRESUMED
(beginning of a coroutine) and RETURNED
/POISONED
(end of a coroutine) states.
source§fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx>
fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx>
The valid variant indices of this coroutine.
source§fn discriminant_for_variant(
&self,
def_id: DefId,
tcx: TyCtxt<'tcx>,
variant_index: VariantIdx,
) -> Discr<'tcx>
fn discriminant_for_variant( &self, def_id: DefId, tcx: TyCtxt<'tcx>, variant_index: VariantIdx, ) -> Discr<'tcx>
The discriminant for the given variant. Panics if the variant_index
is
out of range.
source§fn discriminants(
self,
def_id: DefId,
tcx: TyCtxt<'tcx>,
) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx>
fn discriminants( self, def_id: DefId, tcx: TyCtxt<'tcx>, ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx>
The set of all discriminants for the coroutine, enumerated with their variant indices.
source§fn variant_name(v: VariantIdx) -> Cow<'static, str>
fn variant_name(v: VariantIdx) -> Cow<'static, str>
Calls f
with a reference to the name of the enumerator for the given
variant v
.
source§fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>
fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>
The type of the state discriminant used in the coroutine type.
source§fn state_tys(
self,
def_id: DefId,
tcx: TyCtxt<'tcx>,
) -> impl Iterator<Item: Iterator<Item = Ty<'tcx>> + Captures<'tcx>>
fn state_tys( self, def_id: DefId, tcx: TyCtxt<'tcx>, ) -> impl Iterator<Item: Iterator<Item = Ty<'tcx>> + Captures<'tcx>>
This returns the types of the MIR locals which had to be stored across suspension points. It is calculated in rustc_mir_transform::coroutine::StateTransform. All the types here must be in the tuple in CoroutineInterior.
The locals are grouped by their variant number. Note that some locals may be repeated in multiple variants.
source§fn prefix_tys(self) -> &'tcx List<Ty<'tcx>>
fn prefix_tys(self) -> &'tcx List<Ty<'tcx>>
This is the types of the fields of a coroutine which are not stored in a variant.
const UNRESUMED_NAME: &'static str = "Unresumed"
const RETURNED_NAME: &'static str = "Returned"
const POISONED_NAME: &'static str = "Panicked"
source§impl<I> Debug for CoroutineArgs<I>where
I: Interner,
impl<I> Debug for CoroutineArgs<I>where
I: Interner,
source§impl<I> Hash for CoroutineArgs<I>where
I: Interner,
impl<I> Hash for CoroutineArgs<I>where
I: Interner,
source§impl<I, J> Lift<J> for CoroutineArgs<I>where
I: Interner,
J: Interner,
<I as Interner>::GenericArgs: Lift<J, Lifted = <J as Interner>::GenericArgs>,
impl<I, J> Lift<J> for CoroutineArgs<I>where
I: Interner,
J: Interner,
<I as Interner>::GenericArgs: Lift<J, Lifted = <J as Interner>::GenericArgs>,
type Lifted = CoroutineArgs<J>
fn lift_to_interner(self, interner: J) -> Option<CoroutineArgs<J>>
source§impl<I> PartialEq for CoroutineArgs<I>where
I: Interner,
impl<I> PartialEq for CoroutineArgs<I>where
I: Interner,
source§fn eq(&self, other: &CoroutineArgs<I>) -> bool
fn eq(&self, other: &CoroutineArgs<I>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<I> TypeFoldable<I> for CoroutineArgs<I>
impl<I> TypeFoldable<I> for CoroutineArgs<I>
source§fn try_fold_with<__F>(
self,
__folder: &mut __F,
) -> Result<CoroutineArgs<I>, <__F as FallibleTypeFolder<I>>::Error>where
__F: FallibleTypeFolder<I>,
fn try_fold_with<__F>(
self,
__folder: &mut __F,
) -> Result<CoroutineArgs<I>, <__F as FallibleTypeFolder<I>>::Error>where
__F: FallibleTypeFolder<I>,
source§fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
fn fold_with<F>(self, folder: &mut F) -> Selfwhere
F: TypeFolder<I>,
try_fold_with
for use with infallible
folders. Do not override this method, to ensure coherence with
try_fold_with
.source§impl<I> TypeVisitable<I> for CoroutineArgs<I>
impl<I> TypeVisitable<I> for CoroutineArgs<I>
source§fn visit_with<__V>(
&self,
__visitor: &mut __V,
) -> <__V as TypeVisitor<I>>::Resultwhere
__V: TypeVisitor<I>,
fn visit_with<__V>(
&self,
__visitor: &mut __V,
) -> <__V as TypeVisitor<I>>::Resultwhere
__V: TypeVisitor<I>,
impl<I> Copy for CoroutineArgs<I>where
I: Interner,
impl<I> Eq for CoroutineArgs<I>where
I: Interner,
Auto Trait Implementations§
impl<I> Freeze for CoroutineArgs<I>
impl<I> RefUnwindSafe for CoroutineArgs<I>
impl<I> Send for CoroutineArgs<I>
impl<I> Sync for CoroutineArgs<I>
impl<I> Unpin for CoroutineArgs<I>
impl<I> UnwindSafe for CoroutineArgs<I>
Blanket Implementations§
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'a mut [T]
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Filterable for T
impl<T> Filterable for T
source§fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for T
impl<'tcx, T> IsSuggestable<'tcx> for T
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
impl<I, T> TypeVisitableExt<I> for Twhere
I: Interner,
T: TypeVisitable<I>,
fn has_type_flags(&self, flags: TypeFlags) -> bool
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
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 error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>
source§fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
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
fn has_escaping_bound_vars(&self) -> bool
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 morefn has_aliases(&self) -> bool
fn has_inherent_projections(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_coroutines(&self) -> bool
fn references_error(&self) -> bool
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 has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_bound_regions(&self) -> bool
fn has_bound_regions(&self) -> bool
source§fn has_non_region_bound_vars(&self) -> bool
fn has_non_region_bound_vars(&self) -> bool
source§fn has_bound_vars(&self) -> bool
fn has_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeSendSync for T
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.