Struct adblock::blocker::BlockerResult

pub struct BlockerResult {
    pub matched: bool,
    pub important: bool,
    pub redirect: Option<String>,
    pub rewritten_url: Option<String>,
    pub exception: Option<String>,
    pub filter: Option<String>,
}

Describes how a particular network request should be handled.

Fields

matched: bool

Was a blocking filter matched for this request?

important: bool

Important is used to signal that a rule with the important option matched. An important match means that exceptions should not apply and no further checking is neccesary–the request should be blocked (empty body or cancelled).

Brave Browser keeps multiple instances of Blocker, so important here is used to correct behaviour between them: checking should stop instead of moving to the next instance iff an important rule matched.

redirect: Option<String>

Specifies what to load instead of the original request, rather than just blocking it outright. This can come from a filter with a redirect or redirect-rule option. If present, the field will contain the body of the redirect to be injected.

Note that the presence of a redirect does not imply that the request should be blocked. The redirect-rule option can produce a redirection that’s only applied if another blocking filter matches a request.

rewritten_url: Option<String>

removeparam may remove URL parameters. If the original request URL was modified at all, the new version will be here. This should be used as long as the request is not blocked.

exception: Option<String>

Contains a string representation of any matched exception rule. Effectively this means that there was a match, but the request should not be blocked.

If debugging was not enabled (see crate::FilterSet::new), this will only contain a constant "NetworkFilter" placeholder string.

filter: Option<String>

When matched is true, this contains a string representation of the matched blocking rule.

If debugging was not enabled (see crate::FilterSet::new), this will only contain a constant "NetworkFilter" placeholder string.

Trait Implementations

impl Debug for BlockerResult

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

Formats the value using the given formatter.

impl Default for BlockerResult

fn default() -> BlockerResult

Returns the “default value” for a type.

impl Serialize for BlockerResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.