Struct lightningcss::declaration::DeclarationBlock

pub struct DeclarationBlock<'i> {
    pub important_declarations: Vec<Property<'i>>,
    pub declarations: Vec<Property<'i>>,
}

A CSS declaration block.

Properties are separated into a list of !important declararations, and a list of normal declarations. This reduces memory usage compared with storing a boolean along with each property.

Fields

important_declarations: Vec<Property<'i>>

A list of !important declarations in the block.

declarations: Vec<Property<'i>>

A list of normal declarations in the block.

Implementations

impl<'i> DeclarationBlock<'i>

pub fn parse<'a, 'o, 't, T>(
    input: &mut Parser<'i, 't>,
    options: &'a ParserOptions<'o, 'i, T>
) -> Result<Self, ParseError<'i, ParserError<'i>>>

Parses a declaration block from CSS syntax.

pub fn parse_string<'o, T>(
    input: &'i str,
    options: ParserOptions<'o, 'i, T>
) -> Result<Self, ParseError<'i, ParserError<'i>>>

Parses a declaration block from a string.

pub fn new() -> Self

Returns an empty declaration block.

pub fn len(&self) -> usize

Returns the total number of declarations in the block.

impl<'i> DeclarationBlock<'i>

pub fn to_css_block<W>(
    &self,
    dest: &mut Printer<'_, '_, '_, W>
) -> Result<(), PrinterError>where
    W: Write,

Writes the declarations to a CSS block, including starting and ending braces.

impl<'i> DeclarationBlock<'i>

pub fn is_empty(&self) -> bool

Returns whether the declaration block is empty.

impl<'i> DeclarationBlock<'i>

pub fn iter(&self) -> impl DoubleEndedIterator<Item = (&Property<'i>, bool)>

Returns an iterator over all properties in the declaration.

pub fn iter_mut(&mut self) -> impl DoubleEndedIterator<Item = &mut Property<'i>>

Returns a mutable iterator over all properties in the declaration.

pub fn get<'a>(
    &'a self,
    property_id: &PropertyId<'_>
) -> Option<(Cow<'a, Property<'i>>, bool)>

Returns the value for a given property id based on the properties in this declaration block.

If the property is a shorthand, the result will be a combined value of all of the included longhands, or None if some of the longhands are not declared. Otherwise, the value will be either an explicitly declared longhand, or a value extracted from a shorthand property.

pub fn set(&mut self, property: Property<'i>, important: bool)

Sets the value and importance for a given property, replacing any existing declarations.

If the property already exists within the declaration block, it is updated in place. Otherwise, a new declaration is appended. When updating a longhand property and a shorthand is defined which includes the longhand, the shorthand will be updated rather than appending a new declaration.

pub fn remove(&mut self, property_id: &PropertyId<'_>)

Removes all declarations of the given property id from the declaration block.

When removing a longhand property and a shorthand is defined which includes the longhand, the shorthand will be split apart into its component longhand properties, minus the property to remove. When removing a shorthand, all included longhand properties are also removed.

Trait Implementations

impl<'i> Clone for DeclarationBlock<'i>

fn clone(&self) -> DeclarationBlock<'i>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'i> Debug for DeclarationBlock<'i>

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

Formats the value using the given formatter.

impl<'i> PartialEq<DeclarationBlock<'i>> for DeclarationBlock<'i>

fn eq(&self, other: &DeclarationBlock<'i>) -> 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<'i> ToCss for DeclarationBlock<'i>

fn to_css<W>(
    &self,
    dest: &mut Printer<'_, '_, '_, W>
) -> Result<(), PrinterError>where
    W: Write,

Serialize self in CSS syntax, writing to dest.

fn to_css_string(
    &self,
    options: PrinterOptions<'_>
) -> Result<String, PrinterError>

Serialize self in CSS syntax and return a string.

impl<'i, __T: Visit<'i, __T, __V>, __V: Visitor<'i, __T>> Visit<'i, __T, __V> for DeclarationBlock<'i>

const CHILD_TYPES: VisitTypes = _

The types of values contained within this value and its children. This is used to skip branches that don’t have any values requested by the Visitor.

fn visit_children(&mut self, visitor: &mut __V)

Visit the children of this value.

fn visit(&mut self, visitor: &mut V)

Visits the value by calling an appropriate method on the Visitor. If no corresponding visitor method exists, then the children are visited.

impl<'i> StructuralPartialEq for DeclarationBlock<'i>