adblock 0.13.0

Native Rust module for Adblock Plus syntax (e.g. EasyList, EasyPrivacy) filter parsing and matching.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Utilities for attributing matched filter rules to their original in-list representations.

use serde::Serialize;
use std::fmt;

/// Additional information about any filter rule matched by the [crate::Engine].
///
/// This information is available on a best-effort basis from any engine which has been built from a
/// [crate::FilterSet] with the `debug` argument set to `true`.
#[derive(Debug, Default, PartialEq, Serialize)]
pub struct FilterRuleDebugInfo {
    /// String representation of the original filter rule.
    ///
    /// Note that this may be a "best effort" representation in cases where multiple filters have
    /// been fused as part of an optimization.
    pub raw_line: Option<String>,
    /// Location of the original filter rule within the filter lists.
    ///
    /// This may be missing if multiple filters have been fused together.
    pub source_location: Option<SourceLocation>,
}

impl fmt::Display for FilterRuleDebugInfo {
    fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        if let Some(location) = &self.source_location {
            write!(f, "{location}: ")
        } else {
            write!(f, "x:x: ")
        }?;

        if let Some(raw_line) = &self.raw_line {
            write!(f, "{raw_line}")
        } else {
            write!(f, "! unknown")
        }
    }
}

/// Location of a filter rule within sources compiled to a [crate::FilterSet].
#[derive(Debug, Default, PartialEq, Serialize)]
pub struct SourceLocation {
    /// The numeric index of the source as per [crate::lists::AddedFiltersRecord::source_index].
    pub source_index: u32,
    /// Zero-indexed line number of the filter within the source list.
    pub line_number: u32,
}

impl fmt::Display for SourceLocation {
    fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        write!(f, "{}:{}", self.source_index, self.line_number)
    }
}