Struct rustc_middle::ty::GeneratorSubsts

pub struct GeneratorSubsts<'tcx> {
    pub substs: SubstsRef<'tcx>,
}

Similar to ClosureSubsts; see the above documentation for more.

Fields

substs: SubstsRef<'tcx>

Implementations

impl<'tcx> GeneratorSubsts<'tcx>

pub fn new(
    tcx: TyCtxt<'tcx>,
    parts: GeneratorSubstsParts<'tcx, Ty<'tcx>>
) -> GeneratorSubsts<'tcx>

Construct GeneratorSubsts from GeneratorSubstsParts, containing Substs for the generator parent, alongside additional generator-specific components.

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

Divides the generator substs into their respective components. The ordering assumed here must match that used by GeneratorSubsts::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 GeneratorSubsts 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_substs(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) -> impl Iterator<Item = Ty<'tcx>> + '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> GeneratorSubsts<'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.

const UNRESUMED_NAME: &'static str = "Unresumed"

const RETURNED_NAME: &'static str = "Returned"

const POISONED_NAME: &'static str = "Panicked"

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) -> impl Iterator<Item = 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 GeneratorSubsts<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for GeneratorSubsts<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, '__lifted> Lift<'__lifted> for GeneratorSubsts<'tcx>

type Lifted = GeneratorSubsts<'__lifted>

fn lift_to_tcx(
    self,
    __tcx: TyCtxt<'__lifted>
) -> Option<GeneratorSubsts<'__lifted>>

impl<'tcx> PartialEq<GeneratorSubsts<'tcx>> for GeneratorSubsts<'tcx>

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

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

impl<'tcx> TypeFoldable<'tcx> for GeneratorSubsts<'tcx>

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

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<'tcx> for GeneratorSubsts<'tcx>

fn visit_with<__V: TypeVisitor<'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).

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.

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

fn has_projections(&self) -> bool

fn has_opaque_types(&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 needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&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 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> Copy for GeneratorSubsts<'tcx>

impl<'tcx> Eq for GeneratorSubsts<'tcx>

impl<'tcx> StructuralEq for GeneratorSubsts<'tcx>

impl<'tcx> StructuralPartialEq for GeneratorSubsts<'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: 8 bytes