Struct rustc_middle::ty::GeneratorArgs
source · pub struct GeneratorArgs<'tcx> {
pub args: GenericArgsRef<'tcx>,
}
Expand description
Similar to ClosureArgs
; see the above documentation for more.
Fields§
§args: GenericArgsRef<'tcx>
Implementations§
source§impl<'tcx> GeneratorArgs<'tcx>
impl<'tcx> GeneratorArgs<'tcx>
sourcepub fn new(
tcx: TyCtxt<'tcx>,
parts: GeneratorArgsParts<'tcx, Ty<'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.
sourcefn split(self) -> GeneratorArgsParts<'tcx, GenericArg<'tcx>>
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.
sourcepub fn is_valid(self) -> bool
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.
sourcepub fn parent_args(self) -> &'tcx [GenericArg<'tcx>]
pub fn parent_args(self) -> &'tcx [GenericArg<'tcx>]
Returns the substitutions of the generator’s parent.
sourcepub fn witness(self) -> Ty<'tcx>
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.
sourcepub fn upvar_tys(self) -> &'tcx List<Ty<'tcx>>
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.
sourcepub fn tupled_upvars_ty(self) -> Ty<'tcx>
pub fn tupled_upvars_ty(self) -> Ty<'tcx>
Returns the tuple type representing the upvars for this generator.
sourcepub fn resume_ty(self) -> Ty<'tcx>
pub fn resume_ty(self) -> Ty<'tcx>
Returns the type representing the resume type of the generator.
sourcepub fn yield_ty(self) -> Ty<'tcx>
pub fn yield_ty(self) -> Ty<'tcx>
Returns the type representing the yield type of the generator.
sourcepub fn return_ty(self) -> Ty<'tcx>
pub fn return_ty(self) -> Ty<'tcx>
Returns the type representing the return type of the generator.
sourcepub fn poly_sig(self) -> PolyGenSig<'tcx>
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.
source§impl<'tcx> GeneratorArgs<'tcx>
impl<'tcx> GeneratorArgs<'tcx>
const UNRESUMED_NAME: &'static str = "Unresumed"
const RETURNED_NAME: &'static str = "Returned"
const POISONED_NAME: &'static str = "Panicked"
sourcepub fn variant_range(
&self,
def_id: DefId,
tcx: TyCtxt<'tcx>
) -> Range<VariantIdx>
pub fn variant_range( &self, def_id: DefId, tcx: TyCtxt<'tcx> ) -> Range<VariantIdx>
The valid variant indices of this generator.
sourcepub fn discriminant_for_variant(
&self,
def_id: DefId,
tcx: TyCtxt<'tcx>,
variant_index: VariantIdx
) -> Discr<'tcx>
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.
sourcepub fn discriminants(
self,
def_id: DefId,
tcx: TyCtxt<'tcx>
) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx>
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.
sourcepub fn variant_name(v: VariantIdx) -> Cow<'static, str>
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
.
sourcepub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>
pub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx>
The type of the state discriminant used in the generator type.
sourcepub fn state_tys(
self,
def_id: DefId,
tcx: TyCtxt<'tcx>
) -> impl Iterator<Item = impl Iterator<Item = Ty<'tcx>> + Captures<'tcx>>
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.
sourcepub fn prefix_tys(self) -> &'tcx List<Ty<'tcx>>
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§
source§impl<'tcx> Clone for GeneratorArgs<'tcx>
impl<'tcx> Clone for GeneratorArgs<'tcx>
source§fn clone(&self) -> GeneratorArgs<'tcx>
fn clone(&self) -> GeneratorArgs<'tcx>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'tcx> Debug for GeneratorArgs<'tcx>
impl<'tcx> Debug for GeneratorArgs<'tcx>
source§impl<'tcx> PartialEq<GeneratorArgs<'tcx>> for GeneratorArgs<'tcx>
impl<'tcx> PartialEq<GeneratorArgs<'tcx>> for GeneratorArgs<'tcx>
source§fn eq(&self, other: &GeneratorArgs<'tcx>) -> bool
fn eq(&self, other: &GeneratorArgs<'tcx>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'tcx> Relate<'tcx> for GeneratorArgs<'tcx>
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>>
source§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for GeneratorArgs<'tcx>
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for GeneratorArgs<'tcx>
source§fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>(
self,
__folder: &mut __F
) -> Result<Self, __F::Error>
fn try_fold_with<__F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, __folder: &mut __F ) -> Result<Self, __F::Error>
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<'tcx> TypeVisitable<TyCtxt<'tcx>> for GeneratorArgs<'tcx>
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for GeneratorArgs<'tcx>
source§fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>(
&self,
__visitor: &mut __V
) -> ControlFlow<__V::BreakTy>
fn visit_with<__V: TypeVisitor<TyCtxt<'tcx>>>( &self, __visitor: &mut __V ) -> ControlFlow<__V::BreakTy>
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§
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, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§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 Twhere
T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
impl<'tcx, T> IsSuggestable<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<'tcx, T> ToPredicate<'tcx, T> for T
impl<'tcx, T> ToPredicate<'tcx, T> for T
fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T
source§impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere
T: TypeVisitable<TyCtxt<'tcx>>,
impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>>,
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.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_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
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_late_bound_regions(&self) -> bool
fn has_late_bound_regions(&self) -> bool
source§fn has_non_region_late_bound(&self) -> bool
fn has_non_region_late_bound(&self) -> bool
source§fn has_late_bound_vars(&self) -> bool
fn has_late_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.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: &[QueryInfo], _guar: ErrorGuaranteed ) -> T
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