Struct rustc_middle::ty::GeneratorArgs

impl<'tcx> GeneratorArgs<'tcx>

pub fn new( tcx: TyCtxt<'tcx>, parts: GeneratorArgsParts<'tcx, Ty<'tcx>> ) -> GeneratorArgs<'tcx>

Construct GeneratorArgs from GeneratorArgsParts, containing Args for the generator parent, alongside additional generator-specific components.

fn split(self) -> GeneratorArgsParts<'tcx, GenericArg<'tcx>>

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

pub fn is_valid(self) -> bool

Returns true only if enough of the synthetic types are known to allow using all of the methods on GeneratorArgs without panicking.

Used primarily by ty::print::pretty to be able to handle generator types that haven’t had their synthetic types substituted in.

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

Returns the substitutions of the generator’s parent.

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

This describes the types that can be contained in a generator. 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 generator 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 generator. 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 generator.

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

Returns the type representing the resume type of the generator.

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

Returns the type representing the yield type of the generator.

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

Returns the type representing the return type of the generator.

pub fn poly_sig(self) -> PolyGenSig<'tcx>

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

N.B., some bits of the code prefers to see this wrapped in a binder, but it never contains bound regions. Probably this function should be removed.

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

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

impl<'tcx> GeneratorArgs<'tcx>

pub const UNRESUMED: usize = 0usize

Generator has not been resumed yet.

pub const RETURNED: usize = 1usize

Generator has returned or is completed.

pub const POISONED: usize = 2usize

Generator has been poisoned.

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

The valid variant indices of this generator.

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 generator, 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 generator type.

pub fn state_tys( self, def_id: DefId, tcx: TyCtxt<'tcx> ) -> impl Iterator<Item = impl 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::generator::StateTransform. All the types here must be in the tuple in GeneratorInterior.

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 generator which are not stored in a variant.

Trait Implementations§

impl<'tcx> Clone for GeneratorArgs<'tcx>

fn clone(&self) -> GeneratorArgs<'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 GeneratorArgs<'tcx>

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

Formats the value using the given formatter. Read more

impl<'tcx> PartialEq<GeneratorArgs<'tcx>> for GeneratorArgs<'tcx>

fn eq(&self, other: &GeneratorArgs<'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 GeneratorArgs<'tcx>

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

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for GeneratorArgs<'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) -> Selfwhere 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 GeneratorArgs<'tcx>

fn visit_with<V: TypeVisitor<TyCtxt<'tcx>>>( &self, visitor: &mut V ) -> ControlFlow<V::BreakTy>

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 GeneratorArgs<'tcx>

impl<'tcx> Eq for GeneratorArgs<'tcx>

impl<'tcx> StructuralEq for GeneratorArgs<'tcx>

impl<'tcx> StructuralPartialEq for GeneratorArgs<'tcx>

Auto Trait Implementations§

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

impl<'tcx> Send for GeneratorArgs<'tcx>

impl<'tcx> Sync for GeneratorArgs<'tcx>

impl<'tcx> Unpin for GeneratorArgs<'tcx>

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

Blanket Implementations§

impl<T> Aligned for T

const ALIGN: Alignment = _

Alignment of Self.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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]

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere 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) -> Rwhere I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

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

type Output = R

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere 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 Twhere 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> ToOwned for Twhere 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 Twhere 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 Twhere 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<'tcx, T> TypeVisitableExt<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>>,

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

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

fn has_projections(&self) -> bool

fn has_inherent_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn has_generators(&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 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_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn has_non_region_late_bound(&self) -> bool

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

fn has_late_bound_vars(&self) -> bool

True if there are any late-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<Tcx, T> Value<Tcx> for Twhere Tcx: DepContext,