Struct AtRule

pub struct AtRule<AT, P, B>
where
    AT: Into<AtKeyword>,
{
    pub name: AtKeyword,
    pub prelude: P,
    pub block: B,
    pub semicolon: Option<Semicolon>,
    /* private fields */
}

This struct provides the generic <at-rule> grammar. It will consume an at-rule. This is defined as:

<at-rule>
 │├─ <AT> ─ <P> ─ <B> ─╭───────╮┤│
                       ╰─ ";" ─╯

<AT> must implement Peek, Parse, and Into<token_macros::AtKeyword>. This helps enforce that this is an at-rule, that the first token has to be a specific AtKeyword.

<P> - the prelude - must implement Parse, ToCursors, and ToSpan. To make the prelude optional simply use an Option. To enforce no prelude the NoPreludeAllowed type can be used. Non-optional types are considered required.

<B> - the block - must implement Parse, ToCursors, and ToSpan. To make the block optional simply use an Option. To enforce no block the NoBlockAllowed type can be used. Non-optional types are considered required. Ideally the block should implement one of Block, DeclarationList, or DeclarationRuleList.

A generic AtRule could be AtRule<T![AtKeyword], ComponentValues<'a>, SimpleBlock>.

To specify extra restrictions on the value of the at-keyword, use atkeyword_set.

Example

use css_parse::*;

/// A grammar like `@test foo {}`
#[derive(Debug)]
pub struct TestAtRule<'a>(AtRule<T![AtKeyword], T![Ident], SimpleBlock<'a>>);

impl<'a> Parse<'a> for TestAtRule<'a> {
    fn parse(p: &mut Parser<'a>) -> Result<Self> {
        Ok(Self(p.parse::<AtRule<T![AtKeyword], T![Ident], SimpleBlock<'a>>>()?))
    }
}

impl ToCursors for TestAtRule<'_> {
    fn to_cursors(&self, s: &mut impl CursorSink) {
        self.0.to_cursors(s);
    }
}

assert_parse!(TestAtRule, "@test foo{}");

Fields

name: AtKeyword

prelude: P

block: B

semicolon: Option<Semicolon>

Trait Implementations

impl<AT, P: Clone, B: Clone> Clone for AtRule<AT, P, B>

where AT: Into<AtKeyword> + Clone,

fn clone(&self) -> AtRule<AT, P, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AT, P: Debug, B: Debug> Debug for AtRule<AT, P, B>

where AT: Into<AtKeyword> + Debug,

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

Formats the value using the given formatter.

impl<AT, P: Hash, B: Hash> Hash for AtRule<AT, P, B>

where AT: Into<AtKeyword> + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<AT, P: Ord, B: Ord> Ord for AtRule<AT, P, B>

where AT: Into<AtKeyword> + Ord,

fn cmp(&self, other: &AtRule<AT, P, B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, AT, P, B> Parse<'a> for AtRule<AT, P, B>

where AT: Parse<'a> + Into<AtKeyword>, P: Parse<'a>, B: Parse<'a>,

fn parse(p: &mut Parser<'a>) -> ParserResult<Self>

fn try_parse(p: &mut Parser<'a>) -> Result<Self>

impl<AT, P: PartialEq, B: PartialEq> PartialEq for AtRule<AT, P, B>

where AT: Into<AtKeyword> + PartialEq,

fn eq(&self, other: &AtRule<AT, P, B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<AT, P: PartialOrd, B: PartialOrd> PartialOrd for AtRule<AT, P, B>

where AT: Into<AtKeyword> + PartialOrd,

fn partial_cmp(&self, other: &AtRule<AT, P, B>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, AT, P, B> Peek<'a> for AtRule<AT, P, B>

where AT: Peek<'a> + Into<AtKeyword>,

fn peek(p: &Parser<'a>, c: Cursor) -> bool

const PEEK_KINDSET: KindSet = KindSet::ANY

impl<AT, P, B> Serialize for AtRule<AT, P, B>

where AT: Into<AtKeyword>, P: Serialize, B: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<AT, P, B> ToCursors for AtRule<AT, P, B>

where AT: Into<AtKeyword>, P: ToCursors, B: ToCursors,

fn to_cursors(&self, s: &mut impl CursorSink)

impl<AT, P, B> ToSpan for AtRule<AT, P, B>

where AT: Into<AtKeyword>, P: ToSpan, B: ToSpan,

fn to_span(&self) -> Span

impl<AT, P: Eq, B: Eq> Eq for AtRule<AT, P, B>

where AT: Into<AtKeyword> + Eq,

impl<AT, P, B> StructuralPartialEq for AtRule<AT, P, B>

where AT: Into<AtKeyword>,