Struct webkit2gtk::UserScript

#[repr(transparent)]
pub struct UserScript { /* private fields */ }

Available on crate feature v2_6 only.

A JavaScript snippet which can be injected in loaded pages.

Implementations

impl UserScript

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

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 UserContentInjectedFrames value

injection_time

A UserScriptInjectionTime value

allow_list

An allow_list of URI patterns or None

block_list

A block_list of URI patterns or None

Returns

A new UserScript

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

Available on crate feature v2_22 only.

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

See new() for a full description.

source

Source code of the user script.

injected_frames

A UserContentInjectedFrames value

injection_time

A UserScriptInjectionTime 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 UserScript

Trait Implementations

impl Clone for UserScript

fn clone(&self) -> Self

Returns a copy of the value.

const 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 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,

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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<UserScript> for UserScript

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

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

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

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

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

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

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

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

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

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

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

const 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 StructuralEq for UserScript

impl StructuralPartialEq for UserScript