Struct Whitespace

pub struct Whitespace { /* private fields */ }

A [bitmask][bitmask_enum] representing the characters that make up a Kind::Whitespace token.

A Token with Kind::Whitespace will store this data internal to the token. Using Token::whitespace_style() will return this bitmask, depending on what characters make up the whitespace token. By default the [Lexer][crate::Lexer] will produce combine multiple whitespaces into a single Token, so it is possible that Token::whitespace_style() could contain all of the available bits here. With [Feature::SeparateWhitespace][crate::Feature::SeparateWhitespace] the [Lexer][crate::Lexer] will produce discrete tokens each which can only have one of the available bits in this bitmask.

use css_lexer::*;
let mut lexer = Lexer::new("\n\t");
{
	// This token will be collapsed Whitespace.
	let token = lexer.advance();
	assert_eq!(token, Kind::Whitespace);
	// The Whitespace is comprised of many bits:
	assert_eq!(token, Whitespace::Newline | Whitespace::Tab);
}

Implementations

impl Whitespace

pub const Space: Whitespace

The whitespace token contains at least 1 Space ( ) character.

pub const Tab: Whitespace

The whitespace token contains at least 1 Tab (\t) character.

pub const Newline: Whitespace

The whitespace token contains at least 1 Newline (\n) or newline-adjacent (\r, \r\n, \u{c}) character.

pub const fn bits(&self) -> u8

Returns the underlying bits of the bitmask.

pub const fn all_bits() -> Whitespace

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn all_flags() -> Whitespace

Returns a bitmask that contains all flags.

pub const fn is_all_bits(&self) -> bool

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn is_all_flags(&self) -> bool

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn all() -> Whitespace

👎Deprecated: Please use the ::all_bits() constructor

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn is_all(&self) -> bool

👎Deprecated: Please use the .is_all_bits() method

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn full() -> Whitespace

👎Deprecated: Please use the ::all_flags() constructor

Returns a bitmask that contains all flags.

pub const fn is_full(&self) -> bool

👎Deprecated: Please use the .is_all_flags() method

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn none() -> Whitespace

Returns a bitmask that does not contain any values.

pub const fn is_none(&self) -> bool

Returns true if the bitmask does not contain any values.

pub const fn truncate(&self) -> Whitespace

Returns a bitmask that only has bits corresponding to flags

pub const fn intersects(&self, other: Whitespace) -> bool

Returns true if self intersects with any value in other, or if other does not contain any values.

This is equivalent to (self & other) != 0 || other == 0.

pub const fn contains(&self, other: Whitespace) -> bool

Returns true if self contains all values of other.

This is equivalent to (self & other) == other.

pub const fn not(self) -> Whitespace

Returns the bitwise NOT of the bitmask.

pub const fn and(self, other: Whitespace) -> Whitespace

Returns the bitwise AND of the bitmask.

pub const fn or(self, other: Whitespace) -> Whitespace

Returns the bitwise OR of the bitmask.

pub const fn xor(self, other: Whitespace) -> Whitespace

Returns the bitwise XOR of the bitmask.

Trait Implementations

impl Binary for Whitespace

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

Formats the value using the given formatter.

impl BitAnd for Whitespace

type Output = Whitespace

The resulting type after applying the & operator.

fn bitand(self, rhs: Whitespace) -> <Whitespace as BitAnd>::Output

Performs the & operation.

impl BitAndAssign for Whitespace

fn bitand_assign(&mut self, rhs: Whitespace)

Performs the &= operation.

impl BitOr for Whitespace

type Output = Whitespace

The resulting type after applying the | operator.

fn bitor(self, rhs: Whitespace) -> <Whitespace as BitOr>::Output

Performs the | operation.

impl BitOrAssign for Whitespace

fn bitor_assign(&mut self, rhs: Whitespace)

Performs the |= operation.

impl BitXor for Whitespace

type Output = Whitespace

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Whitespace) -> <Whitespace as BitXor>::Output

Performs the ^ operation.

impl BitXorAssign for Whitespace

fn bitxor_assign(&mut self, rhs: Whitespace)

Performs the ^= operation.

impl Clone for Whitespace

fn clone(&self) -> Whitespace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Whitespace

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

Formats the value using the given formatter.

impl From<Token> for Whitespace

fn from(token: Token) -> Whitespace

Converts to this type from the input type.

impl From<u8> for Whitespace

fn from(val: u8) -> Whitespace

Converts to this type from the input type.

impl Hash for Whitespace

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

where __H: Hasher,

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 LowerHex for Whitespace

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

Formats the value using the given formatter.

impl Not for Whitespace

type Output = Whitespace

The resulting type after applying the ! operator.

fn not(self) -> <Whitespace as Not>::Output

Performs the unary ! operation.

impl Octal for Whitespace

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

Formats the value using the given formatter.

impl Ord for Whitespace

fn cmp(&self, other: &Whitespace) -> 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 PartialEq<Whitespace> for Token

fn eq(&self, other: &Whitespace) -> 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 PartialEq<u8> for Whitespace

fn eq(&self, other: &u8) -> 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 PartialEq for Whitespace

fn eq(&self, other: &Whitespace) -> 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 PartialOrd for Whitespace

fn partial_cmp(&self, other: &Whitespace) -> 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 UpperHex for Whitespace

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

Formats the value using the given formatter.

impl Copy for Whitespace

impl Eq for Whitespace

impl StructuralPartialEq for Whitespace