Struct rustc_middle::ty::CoroutineArgs

impl<'tcx> CoroutineArgs<'tcx>

pub fn new( tcx: TyCtxt<'tcx>, parts: CoroutineArgsParts<'tcx> ) -> CoroutineArgs<'tcx>

Construct CoroutineArgs from CoroutineArgsParts, containing Args for the coroutine parent, alongside additional coroutine-specific components.

fn split(self) -> CoroutineArgsParts<'tcx>

Divides the coroutine args into their respective components. The ordering assumed here must match that used by CoroutineArgs::new above.

pub fn parent_args(self) -> &'tcx [GenericArg<'tcx>]

Returns the generic parameters of the coroutine’s parent.

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

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

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.

pub fn upvar_tys(self) -> &'tcx List<Ty<'tcx>>

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.

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

Returns the tuple type representing the upvars for this coroutine.

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

Returns the type representing the resume type of the coroutine.

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

Returns the type representing the yield type of the coroutine.

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

Returns the type representing the return type of the coroutine.

pub fn sig(self) -> GenSig<'tcx>

Returns the “coroutine signature”, which consists of its resume, yield and return types.

impl<'tcx> CoroutineArgs<'tcx>

pub const UNRESUMED: usize = 0usize

Coroutine has not been resumed yet.

pub const RETURNED: usize = 1usize

Coroutine has returned or is completed.

pub const POISONED: usize = 2usize

Coroutine has been poisoned.

pub fn variant_range( &self, def_id: DefId, tcx: TyCtxt<'tcx> ) -> Range<VariantIdx>

The valid variant indices of this coroutine.

pub 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.

pub 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.

pub fn variant_name(v: VariantIdx) -> Cow<'static, str>

Calls f with a reference to the name of the enumerator for the given variant v.

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

The type of the state discriminant used in the coroutine type.

pub 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.

pub 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.

Trait Implementations§

impl<'tcx> Clone for CoroutineArgs<'tcx>

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<'tcx> Debug for CoroutineArgs<'tcx>

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

Formats the value using the given formatter. Read more

impl<'tcx> PartialEq for CoroutineArgs<'tcx>

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

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

1.0.0 · source§

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> Relate<'tcx> for CoroutineArgs<'tcx>

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

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for CoroutineArgs<'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). Read more

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

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 CoroutineArgs<'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). Read more

impl<'tcx> Copy for CoroutineArgs<'tcx>

impl<'tcx> Eq for CoroutineArgs<'tcx>

impl<'tcx> StructuralPartialEq for CoroutineArgs<'tcx>

Auto Trait Implementations§

impl<'tcx> DynSend for CoroutineArgs<'tcx>

impl<'tcx> DynSync for CoroutineArgs<'tcx>

impl<'tcx> Freeze for CoroutineArgs<'tcx>

impl<'tcx> !RefUnwindSafe for CoroutineArgs<'tcx>

impl<'tcx> Send for CoroutineArgs<'tcx>

impl<'tcx> Sync for CoroutineArgs<'tcx>

impl<'tcx> Unpin for CoroutineArgs<'tcx>

impl<'tcx> !UnwindSafe for CoroutineArgs<'tcx>

Blanket Implementations§

impl<T> Aligned for T

const ALIGN: Alignment = _

Alignment of Self.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where 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]

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where 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]

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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<_>>()).

type Output = R

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

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

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

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

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

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

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

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

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

impl<T> Filterable for T

fn filterable( self, filter_name: &'static str ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl IntoQueryParam for P

fn into_query_param(self) -> P

impl<'tcx, T> IsSuggestable<'tcx> for T
where T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,

fn is_suggestable(self, tcx: TyCtxt<'tcx>, infer_suggestable: bool) -> bool

Whether this makes sense to suggest in a diagnostic. Read more

fn make_suggestable( self, tcx: TyCtxt<'tcx>, infer_suggestable: bool ) -> Option<T>

impl<T> MaybeResult<T> for T

type Error = !

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<'tcx, T> ToPredicate<'tcx, T> for T

fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

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

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 error_reported(&self) -> Result<(), ::ErrorGuaranteed>

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. Read more

fn has_projections(&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

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_bound_regions(&self) -> bool

True if there are any late-bound regions

fn has_non_region_bound_vars(&self) -> bool

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

fn has_bound_vars(&self) -> bool

True if there are any bound variables

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed ) -> T

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<'a, T> Captures<'a> for T
where T: ?Sized,

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