Struct SourceCursor 

pub struct SourceCursor<'a> { /* private fields */ }

Wraps Cursor with a str that represents the underlying character data for this cursor.

Implementations

impl<'a> SourceCursor<'a>

pub const SPACE: SourceCursor<'static>

pub const TAB: SourceCursor<'static>

pub const NEWLINE: SourceCursor<'static>

pub const SEMICOLON: SourceCursor<'static>

pub const fn from(cursor: Cursor, source: &'a str) -> SourceCursor<'a>

pub const fn cursor(&self) -> Cursor

pub const fn token(&self) -> Token

pub const fn source(&self) -> &'a str

pub fn with_quotes(&self, quote_style: QuoteStyle) -> SourceCursor<'a>

pub fn with_associated_whitespace( &self, rules: AssociatedWhitespaceRules, ) -> SourceCursor<'a>

pub fn compact(&self) -> SourceCursor<'a>

Returns a new SourceCursor with the should_compact flag set.

With the should_compact flag set, the cursor will format with optimised displays of:

• Numbers: Remove leading zeros (0.8 -> .8), trailing zeros (1.0 -> 1), redundant + sign
• Idents/Functions/AtKeywords: Write UTF-8 instead of escape codes
• Dimensions: Same as numbers for the number part, and same as Idents for the unit part
• Whitespace: Normalize to a single space

pub fn may_compact(&self) -> bool

Checks if calling compact().fmt(..) might produce different output than fmt(..).

This can be used to check, rather than a full allocation & display, e.g. format!("{}", sc.compact()).

• Whitespace: returns true if len > 1
• Ident/Function/AtKeyword/Hash: returns true if contains escape chars
• Number: returns true if the number representation could be shortened
• Dimension: combines number and unit checks

pub fn eq_ignore_ascii_case(&self, other: &str) -> bool

pub fn parse<A>(&self, allocator: A) -> CowStr<'a, A>

where A: Allocator + Clone + 'a,

Parse the cursor’s content using any allocator that implements the Allocator trait.

pub fn parse_ascii_lower<A>(&self, allocator: A) -> CowStr<'a, A>

where A: Allocator + Clone + 'a,

Parse the cursor’s content to ASCII lowercase using any allocator that implements the Allocator trait.

Trait Implementations

impl<'a> Clone for SourceCursor<'a>

fn clone(&self) -> SourceCursor<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SourceCursor<'a>

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

Formats the value using the given formatter.

impl<'a> Display for SourceCursor<'a>

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

Formats the value using the given formatter.

impl From<SourceCursor<'_>> for KindSet

fn from(cursor: SourceCursor<'_>) -> KindSet

Converts to this type from the input type.

impl<'a> Hash for SourceCursor<'a>

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<'a> Ord for SourceCursor<'a>

fn cmp(&self, other: &SourceCursor<'a>) -> 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<CommentStyle> for SourceCursor<'_>

fn eq(&self, other: &CommentStyle) -> 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<Kind> for SourceCursor<'_>

fn eq(&self, other: &Kind) -> 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<KindSet> for SourceCursor<'_>

fn eq(&self, other: &KindSet) -> 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<'a> PartialEq for SourceCursor<'a>

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

fn partial_cmp(&self, other: &SourceCursor<'a>) -> 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> ToSpan for SourceCursor<'a>

fn to_span(&self) -> Span

impl<'a> Copy for SourceCursor<'a>

impl<'a> Eq for SourceCursor<'a>

impl<'a> StructuralPartialEq for SourceCursor<'a>