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>;
    fn drive_two<V: ZipAst>(
        &self,
        other: &Self,
        v: &mut V,
    ) -> ControlFlow<V::Break>;

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

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.

Source

fn drive_two<V: ZipAst>(&self, other: &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))
where Self: Sized,

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))
where Self: Sized,

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".

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>

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

Provided Methods§

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

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

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

Dyn Compatibility§

Implementations on Foreign Types§

impl AstVisitable for ()where (): PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for PathBufwhere PathBuf: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for RangeInclusive<IntegerValue>where RangeInclusive<IntegerValue>: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for Stringwhere String: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for Ustrwhere Ustr: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for boolwhere bool: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for charwhere char: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for i128where i128: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for u8where u8: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for u32where u32: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for u64where u64: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for u128where u128: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

impl AstVisitable for usizewhere usize: PartialEq,

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

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

fn drive_two<V: ZipAst>(&self, other: &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>

fn drive_two<V: ZipAst>(&self, other: &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>

fn drive_two<V: ZipAst>(&self, other: &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>

fn drive_two<V: ZipAst>(&self, other: &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>

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

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

Trait AstVisitable

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

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

impl AstVisitable for ()
where (): PartialEq,

impl AstVisitable for PathBuf
where PathBuf: PartialEq,

impl AstVisitable for RangeInclusive<IntegerValue>
where RangeInclusive<IntegerValue>: PartialEq,

impl AstVisitable for String
where String: PartialEq,

impl AstVisitable for Ustr
where Ustr: PartialEq,

impl AstVisitable for bool
where bool: PartialEq,

impl AstVisitable for char
where char: PartialEq,

impl AstVisitable for i128
where i128: PartialEq,

impl AstVisitable for u8
where u8: PartialEq,

impl AstVisitable for u32
where u32: PartialEq,

impl AstVisitable for u64
where u64: PartialEq,

impl AstVisitable for u128
where u128: PartialEq,

impl AstVisitable for usize
where usize: PartialEq,

impl AstVisitable for Abi
where Abi: PartialEq,

impl AstVisitable for BranchId
where BranchId: PartialEq,

impl AstVisitable for BuiltinImplData
where BuiltinImplData: PartialEq,

impl AstVisitable for BuiltinPathElem
where BuiltinPathElem: PartialEq,

impl AstVisitable for Byte
where Byte: PartialEq,

impl AstVisitable for CliOpts
where CliOpts: PartialEq,

impl AstVisitable for DeprecatedSince
where DeprecatedSince: PartialEq,

impl AstVisitable for DropKind
where DropKind: PartialEq,

impl AstVisitable for Error
where Error: PartialEq,

impl AstVisitable for FileName
where FileName: PartialEq,