Struct style::stylesheets::Stylesheet

pub struct Stylesheet {
    pub contents: StylesheetContents,
    pub shared_lock: SharedRwLock,
    pub media: Arc<Locked<MediaList>>,
    pub disabled: AtomicBool,
}

The structure servo uses to represent a stylesheet.

Fields

contents: StylesheetContents

The contents of this stylesheet.

shared_lock: SharedRwLock

The lock used for objects inside this stylesheet

media: Arc<Locked<MediaList>>

List of media associated with the Stylesheet.

disabled: AtomicBool

Whether this stylesheet should be disabled.

Implementations

impl Stylesheet

pub fn from_bytes(
    bytes: &[u8],
    url_data: UrlExtraData,
    protocol_encoding_label: Option<&str>,
    environment_encoding: Option<&'static Encoding>,
    origin: Origin,
    media: MediaList,
    shared_lock: SharedRwLock,
    stylesheet_loader: Option<&dyn StylesheetLoader>,
    error_reporter: Option<&dyn ParseErrorReporter>,
    quirks_mode: QuirksMode
) -> Stylesheet

Parse a stylesheet from a set of bytes, potentially received over the network.

Takes care of decoding the network bytes and forwards the resulting string to Stylesheet::from_str.

pub fn update_from_bytes(
    existing: &Stylesheet,
    bytes: &[u8],
    protocol_encoding_label: Option<&str>,
    environment_encoding: Option<&'static Encoding>,
    url_data: UrlExtraData,
    stylesheet_loader: Option<&dyn StylesheetLoader>,
    error_reporter: Option<&dyn ParseErrorReporter>
)

Updates an empty stylesheet with a set of bytes that reached over the network.

impl Stylesheet

pub fn update_from_str(
    existing: &Stylesheet,
    css: &str,
    url_data: UrlExtraData,
    stylesheet_loader: Option<&dyn StylesheetLoader>,
    error_reporter: Option<&dyn ParseErrorReporter>,
    line_number_offset: u32,
    allow_import_rules: AllowImportRules
)

Updates an empty stylesheet from a given string of text.

fn parse_rules(
    css: &str,
    url_data: &UrlExtraData,
    origin: Origin,
    namespaces: &mut Namespaces,
    shared_lock: &SharedRwLock,
    stylesheet_loader: Option<&dyn StylesheetLoader>,
    error_reporter: Option<&dyn ParseErrorReporter>,
    quirks_mode: QuirksMode,
    line_number_offset: u32,
    use_counters: Option<&UseCounters>,
    allow_import_rules: AllowImportRules,
    sanitization_data: Option<&mut SanitizationData>
) -> (Vec<CssRule>, Option<String>, Option<String>)

pub fn from_str(
    css: &str,
    url_data: UrlExtraData,
    origin: Origin,
    media: Arc<Locked<MediaList>>,
    shared_lock: SharedRwLock,
    stylesheet_loader: Option<&dyn StylesheetLoader>,
    error_reporter: Option<&dyn ParseErrorReporter>,
    quirks_mode: QuirksMode,
    line_number_offset: u32,
    allow_import_rules: AllowImportRules
) -> Self

Creates an empty stylesheet and parses it with a given base url, origin and media.

Effectively creates a new stylesheet and forwards the hard work to Stylesheet::update_from_str.

pub fn disabled(&self) -> bool

Returns whether the stylesheet has been explicitly disabled through the CSSOM.

pub fn set_disabled(&self, disabled: bool) -> bool

Records that the stylesheet has been explicitly disabled through the CSSOM.

Returns whether the the call resulted in a change in disabled state.

Disabled stylesheets remain in the document, but their rules are not added to the Stylist.

Trait Implementations

impl Clone for Stylesheet

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stylesheet

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

Formats the value using the given formatter.

impl StylesheetInDocument for Stylesheet

fn origin(&self, _guard: &SharedRwLockReadGuard) -> Origin

Get the stylesheet origin.

fn quirks_mode(&self, _guard: &SharedRwLockReadGuard) -> QuirksMode

Get the stylesheet quirks mode.

fn media<'a>(
    &'a self,
    guard: &'a SharedRwLockReadGuard
) -> Option<&'a MediaList>

Get the media associated with this stylesheet.

fn enabled(&self) -> bool

Get whether this stylesheet is enabled.

fn rules<'a, 'b: 'a>(
    &'a self,
    guard: &'b SharedRwLockReadGuard
) -> &'a [CssRule]ⓘ

Important traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Returns a reference to the list of rules in this stylesheet.

fn iter_rules<'a, 'b, C>(
    &'a self,
    device: &'a Device,
    guard: &'a SharedRwLockReadGuard<'b>
) -> RulesIterator<'a, 'b, C>ⓘ

Important traits for RulesIterator<'a, 'b, C>

impl<'a, 'b, C> Iterator for RulesIterator<'a, 'b, C> where
    'b: 'a,
    C: NestedRuleIterationCondition + 'static,  type Item = &'a CssRule;

where
    C: NestedRuleIterationCondition, 

Return an iterator using the condition C.

fn is_effective_for_device(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard
) -> bool

Returns whether the style-sheet applies for the current device.

fn effective_rules<'a, 'b>(
    &'a self,
    device: &'a Device,
    guard: &'a SharedRwLockReadGuard<'b>
) -> RulesIterator<'a, 'b, EffectiveRules>ⓘ

Important traits for RulesIterator<'a, 'b, C>

impl<'a, 'b, C> Iterator for RulesIterator<'a, 'b, C> where
    'b: 'a,
    C: NestedRuleIterationCondition + 'static,  type Item = &'a CssRule;

Return an iterator over the effective rules within the style-sheet, as according to the supplied Device.

fn effective_style_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&StyleRule), 

fn effective_media_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&MediaRule), 

fn effective_font_face_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&FontFaceRule), 

fn effective_font_face_feature_values_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&FontFeatureValuesRule), 

fn effective_counter_style_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&CounterStyleRule), 

fn effective_viewport_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&ViewportRule), 

fn effective_keyframes_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&KeyframesRule), 

fn effective_supports_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&SupportsRule), 

fn effective_page_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&PageRule), 

fn effective_document_rules<F>(
    &self,
    device: &Device,
    guard: &SharedRwLockReadGuard,
    f: F
) where
    F: FnMut(&DocumentRule), 

impl ToMediaListKey for Stylesheet

fn to_media_list_key(&self) -> MediaListKey

Get a MediaListKey for this item. This key needs to uniquely identify the item.