How brave/adblock-rust works
adblock-rust is an embeddable adblocking engine. A host supplies filter lists and requests; the engine parses and compiles rules, then evaluates network requests and exposes cosmetic-filter results and resource replacements. The README also documents content-blocking conversion, serialized engine data, and language bindings. Edges reflect the excerpts, SOURCE INDEX references, or README; unsampled implementation details are not inferred.
Main entry points: engine.rs Engine API · blocker.rs Request blocker · cosmetic_filter_cache.rs Cosmetic filter cache · lists.rs Filter list parsing
Components 20
Engine API
- Engine API
src/engine.rs
Rule Processing
- Filter list parsing
src/lists.rs - Network rule parsing
src/filters/network.rs - Cosmetic rule parsing
src/filters/cosmetic.rs - Network compilation
src/filters/fb_network_builder.rs - Cosmetic compilation
src/cosmetic_filter_cache_builder.rs
Matching and Results
- Request blocker
src/blocker.rs - Request model
src/request.rs - Network filter list
src/network_filter_list.rs - Regex management
src/regex_manager.rs - Cosmetic filter cache
src/cosmetic_filter_cache.rs - Cosmetic utilities
src/cosmetic_filter_utils.rs - URL parsing
src/url_parser/mod.rs
Data and Resources
- Resource replacements
src/resources/mod.rs - Resource storage
src/resources/resource_storage.rs - Engine serialization
src/data_format/mod.rs - Flatbuffer context
src/filters/filter_data_context.rs
Host Integrations
- JavaScript bindings
js/src/lib.rs - Content-blocking conversion
src/content_blocking.rs
Other components
- Embedding host
Connections 21
- Embedding host → Engine API: uses
- Engine API → Filter list parsing: parses lists
src/engine.rs - Filter list parsing → Network rule parsing: parses network rules
src/lists.rs - Filter list parsing → Cosmetic rule parsing: parses cosmetic rules
src/lists.rs - Engine API → Network compilation: compiles rules
src/engine.rs - Engine API → Cosmetic compilation: builds cache
src/engine.rs - Engine API → Request blocker: configures
src/engine.rs - Engine API → Engine serialization: serializes engine
src/engine.rs - Engine API → Content-blocking conversion: exports rules
- Engine API → Cosmetic filter cache: queries cosmetics
src/engine.rs - Request blocker → Network filter list: uses filters
src/blocker.rs - Request blocker → Request model: matches request
src/blocker.rs - Request blocker → Regex management: manages regexes
src/blocker.rs - Cosmetic filter cache → Cosmetic rule parsing: uses rules
src/cosmetic_filter_cache.rs - Cosmetic filter cache → Cosmetic utilities: uses utilities
src/cosmetic_filter_cache.rs - Cosmetic filter cache → Resource replacements: resolves resources
src/cosmetic_filter_cache.rs - Resource replacements → Resource storage: uses storage
src/resources/mod.rs - Engine API → Flatbuffer context: holds filter data
src/engine.rs - Embedding host → JavaScript bindings: calls binding
- Request model → URL parsing: parses URL
src/request.rs - Embedding host → Resource replacements: provides replacements