Trait AstVisitable

Source

pub trait AstVisitable: Any {
    // Required methods
    fn drive<V: VisitAst>(&self, v: &mut V) -> ControlFlow<V::Break>;
    fn drive_mut<V: VisitAstMut>(&mut self, v: &mut V) -> ControlFlow<V::Break>;

    // Provided methods
    fn name(&self) -> &'static str { ... }
    fn dyn_visit<T: AstVisitable>(&self, f: impl FnMut(&T)) { ... }
    fn dyn_visit_mut<T: AstVisitable>(&mut self, f: impl FnMut(&mut T)) { ... }
}

Expand description

An overrideable visitor trait that can be used to conveniently traverse the whole contents of an item. This is useful when e.g. dealing with types, which show up pretty much everywhere in the ast.

This defines three traits:

AstVisitable is a trait implemented by all the types listed below; it has a drive[_mut] method that takes a VisitAst[Mut] visitor and calls its methods on all the relevant subvalues of self encountered.
VisitAst[Mut] is a (pair of) visitor trait(s) that can be implemented by visitors. To define a visitor, implement VisitAst[Mut] and override the methods you need.

This trait has a drive[_mut] method that knows how to drive a VisitAst[Mut] visitor. This trait is implemented for all the listed types. If listed as override, the corresponding visitor trait has an overrideable method to visit this type. If listed as drive, the type will only be visited by recursing into its contents.

Morally this represents the predicate for<V: VisitAst[Mut]> Self: Drive[Mut]<AstVisitableWrapper<V>>

Required Methods§

Source

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.

Source

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.

Provided Methods§

Source

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

The name of the type, used for debug logging.

Source

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

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

Source

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.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait AstVisitable Copy item path

Required Methods§

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

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

Provided Methods§

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

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

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

Dyn Compatibility§

Implementations on Foreign Types§

impl AstVisitable for ()

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

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

impl<A: AstVisitable, B: AstVisitable> AstVisitable for Result<A, B>

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

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

impl<A: AstVisitable, B: AstVisitable> AstVisitable for (A, B)

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

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

impl<A: AstVisitable, B: AstVisitable, C: AstVisitable> AstVisitable for (A, B, C)

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

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

impl<K: Any, T: AstVisitable> AstVisitable for HashMap<K, T>

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

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

impl<T: AstVisitable> AstVisitable for Option<T>

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

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

impl<T: AstVisitable> AstVisitable for Box<T>

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

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

impl<T: AstVisitable> AstVisitable for Vec<T>

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

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

Implementors§

impl AstVisitable for AggregateKind

impl AstVisitable for BinOp

impl AstVisitable for BorrowKind

impl AstVisitable for BuiltinFunId

impl AstVisitable for CastKind

impl AstVisitable for ConstantExprKind

impl AstVisitable for FieldProjKind

impl AstVisitable for FnPtrKind

impl AstVisitable for FunId

impl AstVisitable for NullOp

impl AstVisitable for Operand

impl AstVisitable for PlaceKind

impl AstVisitable for ProjectionElem

impl AstVisitable for Rvalue

impl AstVisitable for UnOp

impl AstVisitable for UnsizingMetadata

impl AstVisitable for AbortKind

impl AstVisitable for Body

impl AstVisitable for FnOperand

impl AstVisitable for ItemSource

impl AstVisitable for VTableField

impl AstVisitable for ItemByVal

impl AstVisitable for ItemId

impl AstVisitable for charon_lib::ast::llbc_ast::StatementKind

impl AstVisitable for Switch

impl AstVisitable for ImplElem

impl AstVisitable for PathElem

impl AstVisitable for BuiltinTy

impl AstVisitable for ClosureKind

impl AstVisitable for ConstGeneric

impl AstVisitable for FloatTy

impl AstVisitable for IntTy

impl AstVisitable for IntegerTy

impl AstVisitable for LiteralTy

impl AstVisitable for PtrMetadata

impl AstVisitable for RefKind

impl AstVisitable for Region

impl AstVisitable for TraitRefKind

impl AstVisitable for TyKind

impl AstVisitable for TypeDeclKind

impl AstVisitable for TypeId

impl AstVisitable for UIntTy

impl AstVisitable for charon_lib::ast::ullbc_ast::StatementKind

impl AstVisitable for SwitchTargets

impl AstVisitable for TerminatorKind

Trait AstVisitable