Struct webkit6::UserScript

pub struct UserScript { /* private fields */ }

A JavaScript snippet which can be injected in loaded pages.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl UserScript

pub fn as_ptr(&self) -> *mut WebKitUserScript

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut WebKitUserScript) -> &Self

Borrows the underlying C value.

impl UserScript

pub fn new( source: &str, injected_frames: UserContentInjectedFrames, injection_time: UserScriptInjectionTime, allow_list: &[&str], block_list: &[&str], ) -> UserScript

Creates a new user script.

Scripts can be applied to some URIs only by passing non-null values for @allow_list or @block_list. Passing a None allow_list implies that all URIs are on the allow_list. The script is applied if an URI matches the allow_list and not the block_list. URI patterns must be of the form [protocol]://[host]/[path], where the host and path components can contain the wildcard character (*) to represent zero or more other characters.

source

Source code of the user script.

injected_frames

A #WebKitUserContentInjectedFrames value

injection_time

A #WebKitUserScriptInjectionTime value

allow_list

An allow_list of URI patterns or None

block_list

A block_list of URI patterns or None

Returns

A new #WebKitUserScript

pub fn for_world( source: &str, injected_frames: UserContentInjectedFrames, injection_time: UserScriptInjectionTime, world_name: &str, allow_list: &[&str], block_list: &[&str], ) -> UserScript

Creates a new user script for script world with name @world_name.

See webkit_user_script_new() for a full description.

source

Source code of the user script.

injected_frames

A #WebKitUserContentInjectedFrames value

injection_time

A #WebKitUserScriptInjectionTime value

world_name

the name of a #WebKitScriptWorld

allow_list

An allow_list of URI patterns or None

block_list

A block_list of URI patterns or None

Returns

A new #WebKitUserScript

Trait Implementations

impl Clone for UserScript

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for UserScript

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

Formats the value using the given formatter.

impl From<UserScript> for Value

fn from(s: UserScript) -> Self

Converts to this type from the input type.

impl HasParamSpec for UserScript

type ParamSpec = ParamSpecBoxed

type SetValue = UserScript

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

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, UserScript>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for UserScript

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

Feeds this value into the given Hasher.

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 UserScript

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

This method returns an Ordering between self and other.

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 PartialEq for UserScript

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

This method tests for self and other values to be equal, and is used by ==.

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 PartialOrd for UserScript

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

This method returns an ordering between self and other values if one exists.

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 UserScript

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UserScript

impl StructuralPartialEq for UserScript