Struct Finder

pub struct Finder { /* private fields */ }

A struct to find sub-nodes in AST by by a given Pattern

Implementations

impl Finder

pub fn run(pattern: &str, root: &Node) -> Result<Option<Node>, PatternError>

Performs a search of a given pattern on a given AST.

pattern is a string slice that is used to construct a Pattern.

Trait Implementations

impl Debug for Finder

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

Formats the value using the given formatter.

impl Visitor for Finder

fn on_alias(&mut self, node: &Alias)

Invoked by a Visitor on entering into Alias node.

fn on_and(&mut self, node: &And)

Invoked by a Visitor on entering into And node.

fn on_and_asgn(&mut self, node: &AndAsgn)

Invoked by a Visitor on entering into AndAsgn node.

fn on_arg(&mut self, node: &Arg)

Invoked by a Visitor on entering into Arg node.

fn on_args(&mut self, node: &Args)

Invoked by a Visitor on entering into Args node.

fn on_array(&mut self, node: &Array)

Invoked by a Visitor on entering into Array node.

fn on_array_pattern(&mut self, node: &ArrayPattern)

Invoked by a Visitor on entering into ArrayPattern node.

fn on_array_pattern_with_tail(&mut self, node: &ArrayPatternWithTail)

Invoked by a Visitor on entering into ArrayPatternWithTail node.

fn on_back_ref(&mut self, node: &BackRef)

Invoked by a Visitor on entering into BackRef node.

fn on_begin(&mut self, node: &Begin)

Invoked by a Visitor on entering into Begin node.

fn on_block(&mut self, node: &Block)

Invoked by a Visitor on entering into Block node.

fn on_blockarg(&mut self, node: &Blockarg)

Invoked by a Visitor on entering into Blockarg node.

fn on_block_pass(&mut self, node: &BlockPass)

Invoked by a Visitor on entering into BlockPass node.

fn on_break(&mut self, node: &Break)

Invoked by a Visitor on entering into Break node.

fn on_case(&mut self, node: &Case)

Invoked by a Visitor on entering into Case node.

fn on_case_match(&mut self, node: &CaseMatch)

Invoked by a Visitor on entering into CaseMatch node.

fn on_casgn(&mut self, node: &Casgn)

Invoked by a Visitor on entering into Casgn node.

fn on_cbase(&mut self, node: &Cbase)

Invoked by a Visitor on entering into Cbase node.

fn on_class(&mut self, node: &Class)

Invoked by a Visitor on entering into Class node.

fn on_complex(&mut self, node: &Complex)

Invoked by a Visitor on entering into Complex node.

fn on_const(&mut self, node: &Const)

Invoked by a Visitor on entering into Const node.

fn on_const_pattern(&mut self, node: &ConstPattern)

Invoked by a Visitor on entering into ConstPattern node.

fn on_c_send(&mut self, node: &CSend)

Invoked by a Visitor on entering into CSend node.

fn on_cvar(&mut self, node: &Cvar)

Invoked by a Visitor on entering into Cvar node.

fn on_cvasgn(&mut self, node: &Cvasgn)

Invoked by a Visitor on entering into Cvasgn node.

fn on_def(&mut self, node: &Def)

Invoked by a Visitor on entering into Def node.

fn on_defined(&mut self, node: &Defined)

Invoked by a Visitor on entering into Defined node.

fn on_defs(&mut self, node: &Defs)

Invoked by a Visitor on entering into Defs node.

fn on_dstr(&mut self, node: &Dstr)

Invoked by a Visitor on entering into Dstr node.

fn on_dsym(&mut self, node: &Dsym)

Invoked by a Visitor on entering into Dsym node.

fn on_e_flip_flop(&mut self, node: &EFlipFlop)

Invoked by a Visitor on entering into EFlipFlop node.

fn on_empty_else(&mut self, node: &EmptyElse)

Invoked by a Visitor on entering into EmptyElse node.

fn on_encoding(&mut self, node: &Encoding)

Invoked by a Visitor on entering into Encoding node.

fn on_ensure(&mut self, node: &Ensure)

Invoked by a Visitor on entering into Ensure node.

fn on_erange(&mut self, node: &Erange)

Invoked by a Visitor on entering into Erange node.

fn on_false(&mut self, node: &False)

Invoked by a Visitor on entering into False node.

fn on_file(&mut self, node: &File)

Invoked by a Visitor on entering into File node.

fn on_find_pattern(&mut self, node: &FindPattern)

Invoked by a Visitor on entering into FindPattern node.

fn on_float(&mut self, node: &Float)

Invoked by a Visitor on entering into Float node.

fn on_for(&mut self, node: &For)

Invoked by a Visitor on entering into For node.

fn on_forward_arg(&mut self, node: &ForwardArg)

Invoked by a Visitor on entering into ForwardArg node.

fn on_forwarded_args(&mut self, node: &ForwardedArgs)

Invoked by a Visitor on entering into ForwardedArgs node.

fn on_gvar(&mut self, node: &Gvar)

Invoked by a Visitor on entering into Gvar node.

fn on_gvasgn(&mut self, node: &Gvasgn)

Invoked by a Visitor on entering into Gvasgn node.

fn on_hash(&mut self, node: &Hash)

Invoked by a Visitor on entering into Hash node.

fn on_hash_pattern(&mut self, node: &HashPattern)

Invoked by a Visitor on entering into HashPattern node.

fn on_heredoc(&mut self, node: &Heredoc)

Invoked by a Visitor on entering into Heredoc node.

fn on_if(&mut self, node: &If)

Invoked by a Visitor on entering into If node.

fn on_if_guard(&mut self, node: &IfGuard)

Invoked by a Visitor on entering into IfGuard node.

fn on_i_flip_flop(&mut self, node: &IFlipFlop)

Invoked by a Visitor on entering into IFlipFlop node.

fn on_if_mod(&mut self, node: &IfMod)

Invoked by a Visitor on entering into IfMod node.

fn on_if_ternary(&mut self, node: &IfTernary)

Invoked by a Visitor on entering into IfTernary node.

fn on_index(&mut self, node: &Index)

Invoked by a Visitor on entering into Index node.

fn on_index_asgn(&mut self, node: &IndexAsgn)

Invoked by a Visitor on entering into IndexAsgn node.

fn on_in_pattern(&mut self, node: &InPattern)

Invoked by a Visitor on entering into InPattern node.

fn on_int(&mut self, node: &Int)

Invoked by a Visitor on entering into Int node.

fn on_irange(&mut self, node: &Irange)

Invoked by a Visitor on entering into Irange node.

fn on_ivar(&mut self, node: &Ivar)

Invoked by a Visitor on entering into Ivar node.

fn on_ivasgn(&mut self, node: &Ivasgn)

Invoked by a Visitor on entering into Ivasgn node.

fn on_kwarg(&mut self, node: &Kwarg)

Invoked by a Visitor on entering into Kwarg node.

fn on_kwargs(&mut self, node: &Kwargs)

Invoked by a Visitor on entering into Kwargs node.

fn on_kw_begin(&mut self, node: &KwBegin)

Invoked by a Visitor on entering into KwBegin node.

fn on_kwnilarg(&mut self, node: &Kwnilarg)

Invoked by a Visitor on entering into Kwnilarg node.

fn on_kwoptarg(&mut self, node: &Kwoptarg)

Invoked by a Visitor on entering into Kwoptarg node.

fn on_kwrestarg(&mut self, node: &Kwrestarg)

Invoked by a Visitor on entering into Kwrestarg node.

fn on_kwsplat(&mut self, node: &Kwsplat)

Invoked by a Visitor on entering into Kwsplat node.

fn on_lambda(&mut self, node: &Lambda)

Invoked by a Visitor on entering into Lambda node.

fn on_line(&mut self, node: &Line)

Invoked by a Visitor on entering into Line node.

fn on_lvar(&mut self, node: &Lvar)

Invoked by a Visitor on entering into Lvar node.

fn on_lvasgn(&mut self, node: &Lvasgn)

Invoked by a Visitor on entering into Lvasgn node.

fn on_masgn(&mut self, node: &Masgn)

Invoked by a Visitor on entering into Masgn node.

fn on_match_alt(&mut self, node: &MatchAlt)

Invoked by a Visitor on entering into MatchAlt node.

fn on_match_as(&mut self, node: &MatchAs)

Invoked by a Visitor on entering into MatchAs node.

fn on_match_current_line(&mut self, node: &MatchCurrentLine)

Invoked by a Visitor on entering into MatchCurrentLine node.

fn on_match_nil_pattern(&mut self, node: &MatchNilPattern)

Invoked by a Visitor on entering into MatchNilPattern node.

fn on_match_pattern(&mut self, node: &MatchPattern)

Invoked by a Visitor on entering into MatchPattern node.

fn on_match_pattern_p(&mut self, node: &MatchPatternP)

Invoked by a Visitor on entering into MatchPatternP node.

fn on_match_rest(&mut self, node: &MatchRest)

Invoked by a Visitor on entering into MatchRest node.

fn on_match_var(&mut self, node: &MatchVar)

Invoked by a Visitor on entering into MatchVar node.

fn on_match_with_lvasgn(&mut self, node: &MatchWithLvasgn)

Invoked by a Visitor on entering into MatchWithLvasgn node.

fn on_mlhs(&mut self, node: &Mlhs)

Invoked by a Visitor on entering into Mlhs node.

fn on_module(&mut self, node: &Module)

Invoked by a Visitor on entering into Module node.

fn on_next(&mut self, node: &Next)

Invoked by a Visitor on entering into Next node.

fn on_nil(&mut self, node: &Nil)

Invoked by a Visitor on entering into Nil node.

fn on_nth_ref(&mut self, node: &NthRef)

Invoked by a Visitor on entering into NthRef node.

fn on_numblock(&mut self, node: &Numblock)

Invoked by a Visitor on entering into Numblock node.

fn on_op_asgn(&mut self, node: &OpAsgn)

Invoked by a Visitor on entering into OpAsgn node.

fn on_optarg(&mut self, node: &Optarg)

Invoked by a Visitor on entering into Optarg node.

fn on_or(&mut self, node: &Or)

Invoked by a Visitor on entering into Or node.

fn on_or_asgn(&mut self, node: &OrAsgn)

Invoked by a Visitor on entering into OrAsgn node.

fn on_pair(&mut self, node: &Pair)

Invoked by a Visitor on entering into Pair node.

fn on_pin(&mut self, node: &Pin)

Invoked by a Visitor on entering into Pin node.

fn on_postexe(&mut self, node: &Postexe)

Invoked by a Visitor on entering into Postexe node.

fn on_preexe(&mut self, node: &Preexe)

Invoked by a Visitor on entering into Preexe node.

fn on_procarg0(&mut self, node: &Procarg0)

Invoked by a Visitor on entering into Procarg0 node.

fn on_rational(&mut self, node: &Rational)

Invoked by a Visitor on entering into Rational node.

fn on_redo(&mut self, node: &Redo)

Invoked by a Visitor on entering into Redo node.

fn on_regexp(&mut self, node: &Regexp)

Invoked by a Visitor on entering into Regexp node.

fn on_reg_opt(&mut self, node: &RegOpt)

Invoked by a Visitor on entering into RegOpt node.

fn on_rescue(&mut self, node: &Rescue)

Invoked by a Visitor on entering into Rescue node.

fn on_rescue_body(&mut self, node: &RescueBody)

Invoked by a Visitor on entering into RescueBody node.

fn on_restarg(&mut self, node: &Restarg)

Invoked by a Visitor on entering into Restarg node.

fn on_retry(&mut self, node: &Retry)

Invoked by a Visitor on entering into Retry node.

fn on_return(&mut self, node: &Return)

Invoked by a Visitor on entering into Return node.

fn on_s_class(&mut self, node: &SClass)

Invoked by a Visitor on entering into SClass node.

fn on_self_(&mut self, node: &Self_)

Invoked by a Visitor on entering into Self_ node.

fn on_send(&mut self, node: &Send)

Invoked by a Visitor on entering into Send node.

fn on_shadowarg(&mut self, node: &Shadowarg)

Invoked by a Visitor on entering into Shadowarg node.

fn on_splat(&mut self, node: &Splat)

Invoked by a Visitor on entering into Splat node.

fn on_str(&mut self, node: &Str)

Invoked by a Visitor on entering into Str node.

fn on_super(&mut self, node: &Super)

Invoked by a Visitor on entering into Super node.

fn on_sym(&mut self, node: &Sym)

Invoked by a Visitor on entering into Sym node.

fn on_true(&mut self, node: &True)

Invoked by a Visitor on entering into True node.

fn on_undef(&mut self, node: &Undef)

Invoked by a Visitor on entering into Undef node.

fn on_unless_guard(&mut self, node: &UnlessGuard)

Invoked by a Visitor on entering into UnlessGuard node.

fn on_until(&mut self, node: &Until)

Invoked by a Visitor on entering into Until node.

fn on_until_post(&mut self, node: &UntilPost)

Invoked by a Visitor on entering into UntilPost node.

fn on_when(&mut self, node: &When)

Invoked by a Visitor on entering into When node.

fn on_while(&mut self, node: &While)

Invoked by a Visitor on entering into While node.

fn on_while_post(&mut self, node: &WhilePost)

Invoked by a Visitor on entering into WhilePost node.

fn on_x_heredoc(&mut self, node: &XHeredoc)

Invoked by a Visitor on entering into XHeredoc node.

fn on_xstr(&mut self, node: &Xstr)

Invoked by a Visitor on entering into Xstr node.

fn on_yield(&mut self, node: &Yield)

Invoked by a Visitor on entering into Yield node.

fn on_z_super(&mut self, node: &ZSuper)

Invoked by a Visitor on entering into ZSuper node.

fn visit(&mut self, node: &Node)

Generic visit router that calls on_<type> under the hood