Enum AggregateKind

pub enum AggregateKind {
    Adt(TypeId, Option<VariantId>, Option<FieldId>, GenericArgs),
    Array(Ty, ConstGeneric),
    Closure(FunDeclId, GenericArgs),
}

An aggregated ADT.

Note that ADTs are desaggregated at some point in MIR. For instance, if we have in Rust:

  let ls = Cons(hd, tl);

In MIR we have (yes, the discriminant update happens at the end for some reason):

  (ls as Cons).0 = move hd;
  (ls as Cons).1 = move tl;
  discriminant(ls) = 0; // assuming `Cons` is the variant of index 0

Rem.: in the Aeneas semantics, both cases are handled (in case of desaggregated initialization, ls is initialized to ⊥, then this ⊥ is expanded to Cons (⊥, ⊥) upon the first assignment, at which point we can initialize the field 0, etc.).

Variants

Adt(TypeId, Option<VariantId>, Option<FieldId>, GenericArgs)

A struct, enum or union aggregate. The VariantId, if present, indicates this is an enum and the aggregate uses that variant. The FieldId, if present, indicates this is a union and the aggregate writes into that field. Otherwise this is a struct.

Array(Ty, ConstGeneric)

We don’t put this with the ADT cas because this is the only built-in type with aggregates, and it is a primitive type. In particular, it makes sense to treat it differently because it has a variable number of fields.

Closure(FunDeclId, GenericArgs)

Aggregated values for closures group the function id together with its state.

Implementations

impl AggregateKind

pub fn variant_index_arity(&self) -> (u32, usize)

Trait Implementations

impl AstVisitable for AggregateKind

fn drive<V: VisitAst>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_mut<V: VisitAstMut>(&mut self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn name(&self) -> &'static str

The name of the type, used for debug logging.

fn dyn_visit<T: AstVisitable>(&self, f: impl FnMut(&T))

Visit all occurrences of that type inside self, in pre-order traversal.

fn dyn_visit_mut<T: AstVisitable>(&mut self, f: impl FnMut(&mut T))

Visit all occurrences of that type inside self, in pre-order traversal.

impl BodyVisitable for AggregateKind

fn drive_body<V: VisitBody>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_body_mut<V: VisitBodyMut>( &mut self, v: &mut V, ) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn dyn_visit_in_body<T: BodyVisitable>(&self, f: impl FnMut(&T))

Visit all occurrences of that type inside self, in pre-order traversal.

fn dyn_visit_in_body_mut<T: BodyVisitable>(&mut self, f: impl FnMut(&mut T))

Visit all occurrences of that type inside self, in pre-order traversal.

impl Clone for AggregateKind

fn clone(&self) -> AggregateKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AggregateKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'s, V> Drive<'s, V> for AggregateKind

where V: Visitor + Visit<'s, TypeId> + Visit<'s, Option<VariantId>> + Visit<'s, Option<FieldId>> + Visit<'s, GenericArgs> + Visit<'s, Ty> + Visit<'s, ConstGeneric> + Visit<'s, FunDeclId>,

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveMut<'s, V> for AggregateKind

where V: Visitor + VisitMut<'s, TypeId> + VisitMut<'s, Option<VariantId>> + VisitMut<'s, Option<FieldId>> + VisitMut<'s, GenericArgs> + VisitMut<'s, Ty> + VisitMut<'s, ConstGeneric> + VisitMut<'s, FunDeclId>,

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl Serialize for AggregateKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.