class
Analyzer::Rust::Axum
Overview
Axum analyzer (tree-sitter port). Each .rs file is parsed once
with the vendored Rust grammar; route registrations are picked up
by walking call_expression nodes whose function is a
field_expression named route. Handler bodies are matched
against a same-file function_item index so callee extraction
shares the parsed tree instead of re-scanning the file with
regexes and a body-text wrapper.
Defined in:
analyzer/analyzers/rust/axum.crConstant Summary
-
BUILDER_ROUTE_EMIT_NAMES =
Set {"get", "post", "put", "delete", "patch", "head", "options", "any", "query", "unauthenticated_get", "unauthenticated_post", "unauthenticated_put", "unauthenticated_delete", "unauthenticated_patch", "unauthenticated_head", "unauthenticated_options", "unauthenticated_any", "unauthenticated_query"} -
CROSS_NEST_EVIDENCE_RE =
Regex.union(".nest(", ".nest_api_service(", ".merge(") -
Precompiled union for build_cross_nest_index's per-file evidence gate, so it costs a single PCRE2 match instead of three naive substring scans.
-
EXTRACTOR_PARAM_RES =
{"Query" => {/Query\s*\(\s*[^)]+\s*\)/, /:\s*(?:[A-Za-z_]\w*::)*Query\b/}, "Json" => {/Json\s*\(\s*[^)]+\s*\)/, /:\s*(?:[A-Za-z_]\w*::)*Json\b/}, "Form" => {/Form\s*\(\s*[^)]+\s*\)/, /:\s*(?:[A-Za-z_]\w*::)*Form\b/}} -
Precompiled per extractor type; interpolated regex literals here would be recompiled on every function parameter.
-
HTTP_VERBS =
Set {"get", "post", "put", "delete", "patch", "head", "options", "any", "query"} -
Verbs accepted as the inner handler call (
get(...),post(...), …). Anything outside this set is treated asGETto match the legacy fallback the regex analyzer used.anycoversaxum::routing::any(handler)— a verb-agnostic registration commonly used for WebSocket upgrades and reverse-proxy fallbacks. -
NEST_NAMES =
Set {"nest", "nest_api_service"} -
.nest("/p", router)and aide's.nest_api_service("/p", router)both mount a sub-router under a path prefix. -
ROUTER_EMIT_NAMES =
Set {"route", "route_service", "nest_service", "fallback", "fallback_service", "api_route", "api_route_with"} -
Field-call names whose extracted shape
extract_routeknows how to read.route_service,nest_service, and the twofallback*variants surface in roughly half of all real-world axum apps (static-file mounts, SPA fallbacks, websocket upgrades). -
SERVICE_METHOD =
"ANY" -
Method emitted for service-shaped registrations (
route_service,nest_service,fallback_service). Services aren't bound to a specific HTTP method —tower-http::services::ServeDiraccepts whatever the client sends — so we mirror axum'sanyverb. -
UTOIPA_INDEX_EVIDENCE_RE =
Regex.union("OpenApiRouter", ".routes(") -
Precompiled union for build_utoipa_prefix_index's per-file evidence gate, so it costs a single PCRE2 match instead of two naive substring scans.
-
UTOIPA_VERBS =
Set {"get", "post", "put", "delete", "patch", "head", "options", "trace"}
Class Method Summary
Instance Method Summary
- #analyze
- #analyze_file(path : String) : Array(Endpoint)
-
#tech : String
Instance-side view of the same declaration.
Class methods inherited from class Analyzer::Rust::RustEngine
collect_cfg_test_regions(source : String) : Array(Tuple(Int32, Int32))
collect_cfg_test_regions,
fan_out_verbs(verb : String) : Array(String)
fan_out_verbs,
inside_test_region?(node : LibTreeSitter::TSNode, regions : Array(Tuple(Int32, Int32))) : Bool
inside_test_region?,
test_path?(relative_path : String) : Bool
test_path?
Instance methods inherited from class FileScanEngine
analyze
analyze,
analyze_file(path : String) : Array(Endpoint)
analyze_file
Instance methods inherited from class Analyzer
analyze
analyze,
base_path : String
base_path,
base_paths : Array(String)
base_paths,
base_relative_path(path : String) : String
base_relative_path,
callees_needed? : Bool
callees_needed?,
content_matches?(content : String, markers : Regex) : Bool
content_matches?,
http_header_name(name : String) : String | Nil
http_header_name,
line_number_for_index(content : String, char_index : Int32) : Int32
line_number_for_index,
logger : NoirLogger
logger,
parallel_analyze(files : Array(String), &block : String -> Nil)
parallel_analyze,
read_file_content(path : String) : String
read_file_content,
result : Array(Endpoint)
result,
tech : String
tech,
unique_params(params : Array(Param)) : Array(Param)
unique_params,
url : String
url,
web_root_path(path : String, markers : Array(String)) : String
web_root_path
Constructor methods inherited from class Analyzer
new(options : Hash(String, YAML::Any))
new
Macros inherited from class Analyzer
analyzer_for(tech)
analyzer_for
Instance methods inherited from module FileHelper
all_files : Array(String)
all_files,
get_files_by_basename(basename : String) : Array(String)
get_files_by_basename,
get_files_by_extension(extension : String) : Array(String)
get_files_by_extension,
get_files_by_extensions(extensions : Array(String)) : Array(String)
get_files_by_extensions,
get_files_by_prefix(prefix : String) : Array(String)
get_files_by_prefix,
get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String)
get_files_by_prefix_and_extension,
get_files_by_relative_path(relative_path : String, root : String = "") : Array(String)
get_files_by_relative_path,
get_public_dir_files(base_path : String, folder : String) : Array(String)
get_public_dir_files,
get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String)
get_public_files,
walked_path(expanded : String) : String
walked_path
Class Method Detail
Instance Method Detail
Instance-side view of the same declaration. The per-file rescues live on
this base class, which has no way to name the analyzer that is running
inside them, so a skipped file could not be attributed to a tech.
Deriving it from analyzer_for keeps the name written exactly once.