Struct webkit6::UserContentFilterStore

pub struct UserContentFilterStore { /* private fields */ }

Handles storage of user content filters on disk.

The WebKitUserContentFilterStore provides the means to import and save JSON rule sets, which can be loaded later in an efficient manner. Once filters are stored, the #WebKitUserContentFilter objects which represent them can be added to a #WebKitUserContentManager with webkit_user_content_manager_add_filter().

JSON rule sets are imported using webkit_user_content_filter_store_save() and stored on disk in an implementation defined format. The contents of a filter store must be managed using the #WebKitUserContentFilterStore: a list of all the stored filters can be obtained with webkit_user_content_filter_store_fetch_identifiers(), webkit_user_content_filter_store_load() can be used to retrieve a previously saved filter, and removed from the store with webkit_user_content_filter_store_remove().

Properties

path

The directory used for filter storage. This path is used as the base directory where user content filters are stored on disk.

Readable | Writeable | Construct Only

GLib type: GObject with reference counted clone semantics.

Implementations

impl UserContentFilterStore

pub fn new(storage_path: &str) -> UserContentFilterStore

Create a new #WebKitUserContentFilterStore to manipulate filters stored at @storage_path.

The path must point to a local filesystem, and will be created if needed.

storage_path

path where data for filters will be stored on disk

Returns

a newly created #WebKitUserContentFilterStore

pub fn path(&self) -> Option<GString>

Gets the storage path for user content filters.

Returns

path, as a string.

pub fn load<P: FnOnce(Result<UserContentFilter, Error>) + 'static>( &self, identifier: &str, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously load a content filter given its @identifier.

The filter must have been previously stored using webkit_user_content_filter_store_save().

When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_load_finish() to obtain the resulting filter.

identifier

a filter identifier

cancellable

a #GCancellable or None to ignore

callback

a #GAsyncReadyCallback to call when the load is completed

pub fn load_future( &self, identifier: &str, ) -> Pin<Box_<dyn Future<Output = Result<UserContentFilter, Error>> + 'static>>

pub fn remove<P: FnOnce(Result<(), Error>) + 'static>( &self, identifier: &str, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously remove a content filter given its @identifier.

When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_remove_finish() to check whether the removal was successful.

identifier

a filter identifier

cancellable

a #GCancellable or None to ignore

callback

a #GAsyncReadyCallback to call when the removal is completed

pub fn remove_future( &self, identifier: &str, ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn save<P: FnOnce(Result<UserContentFilter, Error>) + 'static>( &self, identifier: &str, source: &Bytes, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously save a content filter from a set source rule.

Asynchronously save a content filter from a source rule set in the WebKit content extesions JSON format.

The @identifier can be used afterwards to refer to the filter when using webkit_user_content_filter_store_remove() and webkit_user_content_filter_store_load(). When the @identifier has been used in the past, the new filter source will replace the one saved beforehand for the same identifier.

When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_save_finish() to obtain the resulting filter.

identifier

a string used to identify the saved filter

source

#GBytes containing the rule set in JSON format

cancellable

a #GCancellable or None to ignore

callback

a #GAsyncReadyCallback to call when saving is completed

pub fn save_future( &self, identifier: &str, source: &Bytes, ) -> Pin<Box_<dyn Future<Output = Result<UserContentFilter, Error>> + 'static>>

pub fn save_from_file<P: FnOnce(Result<UserContentFilter, Error>) + 'static>( &self, identifier: &str, file: &impl IsA<File>, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously save a content filter from the contents of a file.

Asynchronously save a content filter from the contents of a file, which must be native to the platform, as checked by g_file_is_native(). See webkit_user_content_filter_store_save() for more details.

When the operation is finished, @callback will be invoked, which then can use webkit_user_content_filter_store_save_finish() to obtain the resulting filter.

identifier

a string used to identify the saved filter

file

a #GFile containing the rule set in JSON format

cancellable

a #GCancellable or None to ignore

callback

a #GAsyncReadyCallback to call when saving is completed

pub fn save_from_file_future( &self, identifier: &str, file: &(impl IsA<File> + Clone + 'static), ) -> Pin<Box_<dyn Future<Output = Result<UserContentFilter, Error>> + 'static>>

Trait Implementations

impl Clone for UserContentFilterStore

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for UserContentFilterStore

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

Formats the value using the given formatter.

impl HasParamSpec for UserContentFilterStore

type ParamSpec = ParamSpecObject

type SetValue = UserContentFilterStore

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, UserContentFilterStore>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for UserContentFilterStore

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UserContentFilterStore

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for UserContentFilterStore

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for UserContentFilterStore

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for UserContentFilterStore

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for UserContentFilterStore

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UserContentFilterStore