Struct adblock::FilterSet

pub struct FilterSet { /* fields omitted */ }

Manages a set of rules to be added to an Engine.

To be able to efficiently handle special options like $badfilter, and to allow optimizations, all rules must be available when the Engine is first created. FilterSet allows assembling a compound list from multiple different sources before compiling the rules into an Engine.

Implementations

impl FilterSet

pub fn new(debug: bool) -> Self

Creates a new FilterSet. The debug argument specifies whether or not to save information about the original raw filter rules alongside the more compact internal representation. If enabled, this information will be passed to the corresponding Engine.

pub fn add_filter_list(
    &mut self,
    filter_list: &str,
    format: &str
) -> PyResult<()>

Adds the contents of an entire filter list to this FilterSet. Filters that cannot be parsed successfully are ignored.

The format is a string containing either "standard" (ABP/uBO-style) or "hosts".

pub fn add_filters(
    &mut self,
    filters: Vec<String>,
    format: &str
) -> PyResult<()>

Adds a collection of filter rules to this FilterSet. Filters that cannot be parsed successfully are ignored.

The format is a string containing either "standard" (ABP/uBO-style) or "hosts".

Trait Implementations

impl Clone for FilterSet

fn clone(&self) -> FilterSet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> ExtractExt<'a> for &'a FilterSet

type Target = PyRef<'a, FilterSet>

impl<'a> ExtractExt<'a> for &'a mut FilterSet

type Target = PyRefMut<'a, FilterSet>

impl HasMethodsInventory for FilterSet

type Methods = Pyo3MethodsInventoryForFilterSet

impl HasProtoRegistry for FilterSet

fn registry() -> &'static PyProtoRegistry

impl IntoPy<PyObject> for FilterSet

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for FilterSet

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it's PyDict.

impl PyClassAlloc for FilterSet

unsafe fn new(py: Python<'_>, subtype: *mut PyTypeObject) -> *mut Self::Layout

Allocate the actual field for #[pyclass].

unsafe fn dealloc(py: Python<'_>, self_: *mut Self::Layout)

Deallocate #[pyclass] on the Python heap.

impl PyClassSend for FilterSet

type ThreadChecker = ThreadCheckerStub<FilterSet>

impl PyTypeInfo for FilterSet

type Type = FilterSet

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyCell<Self>

Layout

type BaseLayout = PyCellBase<PyAny>

Layout of Basetype.

type Initializer = PyClassInitializer<Self>

Initializer for layout

type AsRefTarget = PyCell<Self>

Utility type to make AsPyRef work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

fn is_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type