Struct https_everywhere_lib_wasm::RuleSets

pub struct RuleSets(_);

A newtype for rulesets, wrapping all the JS functionality

Methods

impl RuleSets

pub fn new() -> RuleSets

Returns a new JsRulesets struct

pub fn count_targets(&self) -> usize

Returns the number of targets in the current JsRuleSets struct as a usize

pub fn add_all_from_js_array(
    &mut self,
    array: &Array,
    enable_mixed_rulesets: &Boolean,
    rule_active_states: &JsValue,
    scope: &JsValue
)

Construct and add new rulesets given a JS array of values

Arguments

• array - A JS Array object of rulesets
• enable_mixed_rulesets - A JS Boolean indicating whether rulesets which trigger mixed content blocking should be enabled
• rule_active_states - A JS object which lets us know whether rulesets have been disabled or enabled
• scope - An optional JS string which indicates the scope of the current batch of rulesets being added (see the ruleset update channels documentation)

pub fn print_targets(&self)

Print the entire RuleSets struct

pub fn remove_ruleset(&mut self, ruleset_jsval: &JsValue)

Remove a RuleSet from the RuleSets struct

pub fn potentially_applicable(&self, host: &JsValue) -> JsValue

Return a JS set of rulesets that apply to the given host

Arguments

• host - A JS string which indicates the host to search for potentially applicable rulesets

Trait Implementations

impl From<RuleSets> for JsValue

fn from(value: RuleSets) -> Self

Performs the conversion.

impl Debug for RuleSets

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

Formats the value using the given formatter.

impl IntoWasmAbi for RuleSets

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl RefFromWasmAbi for RuleSets

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, RuleSets>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for RuleSets

fn describe()

impl FromWasmAbi for RuleSets

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl OptionIntoWasmAbi for RuleSets

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl OptionFromWasmAbi for RuleSets

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl RefMutFromWasmAbi for RuleSets

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, RuleSets>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi