Struct 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, 't>( input: &mut Parser<'i, 't>, options: &'a ParserOptions<'i>, ) -> Result<Self, ParseError<'i, ParserError<'i>>>

Parses a declaration block from CSS syntax.

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

Parses a declaration block from a string.

pub fn new() -> Self

Returns an empty declaration block.

Examples found in repository

examples/custom_at_rule.rs (line 201)

  fn visit_rule(&mut self, rule: &mut CssRule<'i, AtRule>) -> Result<(), Self::Error> {
    // Replace @apply rule with nested style rule.
    if let CssRule::Custom(AtRule::Apply(apply)) = rule {
      let mut declarations = DeclarationBlock::new();
      for name in &apply.names {
        let Some(applied) = self.rules.get(name) else {
          continue;
        };
        declarations
          .important_declarations
          .extend(applied.important_declarations.iter().cloned());
        declarations.declarations.extend(applied.declarations.iter().cloned());
      }
      *rule = CssRule::Style(StyleRule {
        selectors: Component::Nesting.into(),
        vendor_prefix: VendorPrefix::None,
        declarations,
        rules: CssRuleList(vec![]),
        loc: Location {
          source_index: 0,
          line: apply.loc.line,
          column: apply.loc.column,
        },
      })
    }

    rule.visit_children(self)
  }

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.

pub fn to_css_declarations<W>( &self, dest: &mut Printer<'_, '_, W>, has_nested_rules: bool, selectors: &SelectorList<'_>, source_index: u32, ) -> Result<(), PrinterError>

where W: Write,

Writes the declarations to a CSS declaration block.

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) -> Self

Returns a duplicate 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> Default for DeclarationBlock<'i>

fn default() -> Self

Returns the “default value” for a type.

impl<'de: 'i, 'i> Deserialize<'de> for DeclarationBlock<'i>

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'any, 'i> IntoOwned<'any> for DeclarationBlock<'i>

Available on crate feature into_owned only.

fn into_owned(self) -> Self::Owned

Consumes the value and returns an owned clone.

type Owned = DeclarationBlock<'any>

A variant of Self with a new lifetime.

impl<'i> JsonSchema for DeclarationBlock<'i>

Available on crate feature jsonschema only.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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

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

Equality operator ==.

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

Inequality operator !=.

impl<'i> Serialize for DeclarationBlock<'i>

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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: ?Sized + Visitor<'i, __T>> Visit<'i, __T, __V> for DeclarationBlock<'i>

Available on crate feature visitor only.

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(&mut self, visitor: &mut __V) -> Result<(), __V::Error>

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

fn visit_children(&mut self, visitor: &mut __V) -> Result<(), __V::Error>

Visit the children of this value.