Trait rustc::hir::intravisit::Visitor [−] [src]

pub trait Visitor<'v>: Sized {
    fn visit_nested_item(&mut self, id: ItemId) { ... }
    fn visit_item(&mut self, i: &'v Item) { ... }
    fn visit_name(&mut self, _span: Span, _name: Name) { ... }
    fn visit_mod(&mut self, m: &'v Mod, _s: Span, _n: NodeId) { ... }
    fn visit_foreign_item(&mut self, i: &'v ForeignItem) { ... }
    fn visit_local(&mut self, l: &'v Local) { ... }
    fn visit_block(&mut self, b: &'v Block) { ... }
    fn visit_stmt(&mut self, s: &'v Stmt) { ... }
    fn visit_arm(&mut self, a: &'v Arm) { ... }
    fn visit_pat(&mut self, p: &'v Pat) { ... }
    fn visit_decl(&mut self, d: &'v Decl) { ... }
    fn visit_expr(&mut self, ex: &'v Expr) { ... }
    fn visit_expr_post(&mut self, _ex: &'v Expr) { ... }
    fn visit_ty(&mut self, t: &'v Ty) { ... }
    fn visit_generics(&mut self, g: &'v Generics) { ... }
    fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v FnDecl, b: &'v Block, s: Span, _: NodeId) { ... }
    fn visit_trait_item(&mut self, ti: &'v TraitItem) { ... }
    fn visit_impl_item(&mut self, ii: &'v ImplItem) { ... }
    fn visit_trait_ref(&mut self, t: &'v TraitRef) { ... }
    fn visit_ty_param_bound(&mut self, bounds: &'v TyParamBound) { ... }
    fn visit_poly_trait_ref(&mut self, t: &'v PolyTraitRef, m: &'v TraitBoundModifier) { ... }
    fn visit_variant_data(&mut self, s: &'v VariantData, _: Name, _: &'v Generics, _: NodeId, _: Span) { ... }
    fn visit_struct_field(&mut self, s: &'v StructField) { ... }
    fn visit_enum_def(&mut self, enum_definition: &'v EnumDef, generics: &'v Generics, item_id: NodeId, _: Span) { ... }
    fn visit_variant(&mut self, v: &'v Variant, g: &'v Generics, item_id: NodeId) { ... }
    fn visit_lifetime(&mut self, lifetime: &'v Lifetime) { ... }
    fn visit_lifetime_def(&mut self, lifetime: &'v LifetimeDef) { ... }
    fn visit_path(&mut self, path: &'v Path, _id: NodeId) { ... }
    fn visit_path_list_item(&mut self, prefix: &'v Path, item: &'v PathListItem) { ... }
    fn visit_path_segment(&mut self, path_span: Span, path_segment: &'v PathSegment) { ... }
    fn visit_path_parameters(&mut self, path_span: Span, path_parameters: &'v PathParameters) { ... }
    fn visit_assoc_type_binding(&mut self, type_binding: &'v TypeBinding) { ... }
    fn visit_attribute(&mut self, _attr: &'v Attribute) { ... }
    fn visit_macro_def(&mut self, macro_def: &'v MacroDef) { ... }
    fn visit_vis(&mut self, vis: &'v Visibility) { ... }
}
Unstable (rustc_private)

Each method of the Visitor trait is a hook to be potentially overridden. Each method's default implementation recursively visits the substructure of the input via the corresponding walk method; e.g. the visit_mod method by default calls intravisit::walk_mod.

Note that this visitor does NOT visit nested items by default (this is why the module is called intravisit, to distinguish it from the AST's visit module, which acts differently). If you simply want to visit all items in the crate in some order, you should call Crate::visit_all_items. Otherwise, see the comment on visit_nested_item for details on how to visit nested items.

If you want to ensure that your code handles every variant explicitly, you need to override each method. (And you also need to monitor future changes to Visitor in case a new method with a new default implementation gets introduced.)

Provided Methods

fn visit_nested_item(&mut self, id: ItemId)

Unstable (rustc_private)

Invoked when a nested item is encountered. By default, does nothing. If you want a deep walk, you need to override to fetch the item contents. But most of the time, it is easier (and better) to invoke Crate::visit_all_items, which visits all items in the crate in some order (but doesn't respect nesting).

fn visit_item(&mut self, i: &'v Item)

Unstable (rustc_private)

Visit the top-level item and (optionally) nested items. See visit_nested_item for details.

fn visit_name(&mut self, _span: Span, _name: Name)

Unstable (rustc_private)

fn visit_mod(&mut self, m: &'v Mod, _s: Span, _n: NodeId)

Unstable (rustc_private)

fn visit_foreign_item(&mut self, i: &'v ForeignItem)

Unstable (rustc_private)

fn visit_local(&mut self, l: &'v Local)

Unstable (rustc_private)

fn visit_block(&mut self, b: &'v Block)

Unstable (rustc_private)

fn visit_stmt(&mut self, s: &'v Stmt)

Unstable (rustc_private)

fn visit_arm(&mut self, a: &'v Arm)

Unstable (rustc_private)

fn visit_pat(&mut self, p: &'v Pat)

Unstable (rustc_private)

fn visit_decl(&mut self, d: &'v Decl)

Unstable (rustc_private)

fn visit_expr(&mut self, ex: &'v Expr)

Unstable (rustc_private)

fn visit_expr_post(&mut self, _ex: &'v Expr)

Unstable (rustc_private)

fn visit_ty(&mut self, t: &'v Ty)

Unstable (rustc_private)

fn visit_generics(&mut self, g: &'v Generics)

Unstable (rustc_private)

fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v FnDecl, b: &'v Block, s: Span, _: NodeId)

Unstable (rustc_private)

fn visit_trait_item(&mut self, ti: &'v TraitItem)

Unstable (rustc_private)

fn visit_impl_item(&mut self, ii: &'v ImplItem)

Unstable (rustc_private)

fn visit_trait_ref(&mut self, t: &'v TraitRef)

Unstable (rustc_private)

fn visit_ty_param_bound(&mut self, bounds: &'v TyParamBound)

Unstable (rustc_private)

fn visit_poly_trait_ref(&mut self, t: &'v PolyTraitRef, m: &'v TraitBoundModifier)

Unstable (rustc_private)

fn visit_variant_data(&mut self, s: &'v VariantData, _: Name, _: &'v Generics, _: NodeId, _: Span)

Unstable (rustc_private)

fn visit_struct_field(&mut self, s: &'v StructField)

Unstable (rustc_private)

fn visit_enum_def(&mut self, enum_definition: &'v EnumDef, generics: &'v Generics, item_id: NodeId, _: Span)

Unstable (rustc_private)

fn visit_variant(&mut self, v: &'v Variant, g: &'v Generics, item_id: NodeId)

Unstable (rustc_private)

fn visit_lifetime(&mut self, lifetime: &'v Lifetime)

Unstable (rustc_private)

fn visit_lifetime_def(&mut self, lifetime: &'v LifetimeDef)

Unstable (rustc_private)

fn visit_path(&mut self, path: &'v Path, _id: NodeId)

Unstable (rustc_private)

fn visit_path_list_item(&mut self, prefix: &'v Path, item: &'v PathListItem)

Unstable (rustc_private)

fn visit_path_segment(&mut self, path_span: Span, path_segment: &'v PathSegment)

Unstable (rustc_private)

fn visit_path_parameters(&mut self, path_span: Span, path_parameters: &'v PathParameters)

Unstable (rustc_private)

fn visit_assoc_type_binding(&mut self, type_binding: &'v TypeBinding)

Unstable (rustc_private)

fn visit_attribute(&mut self, _attr: &'v Attribute)

Unstable (rustc_private)

fn visit_macro_def(&mut self, macro_def: &'v MacroDef)

Unstable (rustc_private)

fn visit_vis(&mut self, vis: &'v Visibility)

Unstable (rustc_private)

Implementors