Struct selectors::context::MatchingContext

pub struct MatchingContext<'a, Impl>where
    Impl: SelectorImpl,{
    pub bloom_filter: Option<&'a BloomFilter>,
    pub nth_index_cache: Option<&'a mut NthIndexCache>,
    pub scope_element: Option<OpaqueElement>,
    pub current_host: Option<OpaqueElement>,
    pub pseudo_element_matching_fn: Option<&'a dyn Fn(&Impl::PseudoElement) -> bool>,
    pub extra_data: Impl::ExtraMatchingData,
    /* private fields */
}

Data associated with the matching process for a element. This context is used across many selectors for an element, so it’s not appropriate for transient data that applies to only a single selector.

Fields

bloom_filter: Option<&'a BloomFilter>

Input with the bloom filter used to fast-reject selectors.

nth_index_cache: Option<&'a mut NthIndexCache>

An optional cache to speed up nth-index-like selectors.

scope_element: Option<OpaqueElement>

The element which is going to match :scope pseudo-class. It can be either one :scope element, or the scoping element.

Note that, although in theory there can be multiple :scope elements, in current specs, at most one is specified, and when there is one, scoping element is not relevant anymore, so we use a single field for them.

When this is None, :scope will match the root element.

See https://drafts.csswg.org/selectors-4/#scope-pseudo

current_host: Option<OpaqueElement>

The current shadow host we’re collecting :host rules for.

pseudo_element_matching_fn: Option<&'a dyn Fn(&Impl::PseudoElement) -> bool>

An optional hook function for checking whether a pseudo-element should match when matching_mode is ForStatelessPseudoElement.

extra_data: Impl::ExtraMatchingData

Extra implementation-dependent matching data.

Implementations

impl<'a, Impl> MatchingContext<'a, Impl>where
    Impl: SelectorImpl,

pub fn new(
    matching_mode: MatchingMode,
    bloom_filter: Option<&'a BloomFilter>,
    nth_index_cache: Option<&'a mut NthIndexCache>,
    quirks_mode: QuirksMode
) -> Self

Constructs a new MatchingContext.

pub fn new_for_visited(
    matching_mode: MatchingMode,
    bloom_filter: Option<&'a BloomFilter>,
    nth_index_cache: Option<&'a mut NthIndexCache>,
    visited_handling: VisitedHandlingMode,
    quirks_mode: QuirksMode
) -> Self

Constructs a new MatchingContext for use in visited matching.

pub fn set_quirks_mode(&mut self, quirks_mode: QuirksMode)

Override the quirks mode we’re matching against.

FIXME(emilio): This is a hack for XBL quirks-mode mismatches.

pub fn is_nested(&self) -> bool

Whether we’re matching a nested selector.

pub fn in_negation(&self) -> bool

Whether we’re matching inside a :not(..) selector.

pub fn quirks_mode(&self) -> QuirksMode

The quirks mode of the document.

pub fn matching_mode(&self) -> MatchingMode

The matching-mode for this selector-matching operation.

pub fn classes_and_ids_case_sensitivity(&self) -> CaseSensitivity

The case-sensitivity for class and ID selectors

pub fn nest<F, R>(&mut self, f: F) -> Rwhere
    F: FnOnce(&mut Self) -> R,

Runs F with a deeper nesting level.

pub fn nest_for_negation<F, R>(&mut self, f: F) -> Rwhere
    F: FnOnce(&mut Self) -> R,

Runs F with a deeper nesting level, and marking ourselves in a negation, for a :not(..) selector, for example.

pub fn visited_handling(&self) -> VisitedHandlingMode

pub fn with_visited_handling_mode<F, R>(
    &mut self,
    handling_mode: VisitedHandlingMode,
    f: F
) -> Rwhere
    F: FnOnce(&mut Self) -> R,

Runs F with a different VisitedHandlingMode.

pub fn with_shadow_host<F, E, R>(&mut self, host: Option<E>, f: F) -> Rwhere
    E: Element,
    F: FnOnce(&mut Self) -> R,

Runs F with a given shadow host which is the root of the tree whose rules we’re matching.

pub fn shadow_host(&self) -> Option<OpaqueElement>

Returns the current shadow host whose shadow root we’re matching rules against.