Struct Cursor

pub struct Cursor(/* private fields */);

Expand description

Wraps Token with a SourceOffset, allows it to reason about the character data of the source text.

Implementations§

impl Cursor

pub const DUMMY_SITE_NUMBER_ZERO: Cursor

pub const EMPTY: Cursor

pub const fn new(offset: SourceOffset, token: Token) -> Cursor

pub const fn dummy(token: Token) -> Cursor

pub const fn token(&self) -> Token

pub const fn offset(&self) -> SourceOffset

pub fn end_offset(&self) -> SourceOffset

pub const fn is_empty(&self) -> bool

pub const fn len(&self) -> u32

pub fn span(&self) -> Span

pub fn str_slice<'a>(&self, str: &'a str) -> &'a str

pub fn with_quotes(&self, quote_style: QuoteStyle) -> Cursor

pub fn with_associated_whitespace( &self, rules: AssociatedWhitespaceRules, ) -> Cursor

pub fn atom_bits(&self) -> u32

Trait Implementations§

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Cursor

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

Formats the value using the given formatter. Read more

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type. Read more

impl From<And> for Cursor

fn from(value: And) -> Self

Converts to this type from the input type.

impl From<Any> for Cursor

fn from(value: Any) -> Self

Converts to this type from the input type.

impl From<At> for Cursor

fn from(value: At) -> Self

Converts to this type from the input type.

impl From<AtKeyword> for Cursor

fn from(value: AtKeyword) -> Self

Converts to this type from the input type.

impl From<Backtick> for Cursor

fn from(value: Backtick) -> Self

Converts to this type from the input type.

impl From<BadString> for Cursor

fn from(value: BadString) -> Self

Converts to this type from the input type.

impl From<BadUrl> for Cursor

fn from(value: BadUrl) -> Self

Converts to this type from the input type.

impl From<Bang> for Cursor

fn from(value: Bang) -> Self

Converts to this type from the input type.

impl From<Caret> for Cursor

fn from(value: Caret) -> Self

Converts to this type from the input type.

impl From<CdcOrCdo> for Cursor

fn from(value: CdcOrCdo) -> Self

Converts to this type from the input type.

impl From<Colon> for Cursor

fn from(value: Colon) -> Self

Converts to this type from the input type.

impl From<Comma> for Cursor

fn from(value: Comma) -> Self

Converts to this type from the input type.

impl From<Comment> for Cursor

fn from(value: Comment) -> Self

Converts to this type from the input type.

impl From<Cursor> for Kind

fn from(cursor: Cursor) -> Kind

Converts to this type from the input type.

impl From<Cursor> for KindSet

fn from(cursor: Cursor) -> KindSet

Converts to this type from the input type.

impl From<Cursor> for QuoteStyle

fn from(cursor: Cursor) -> QuoteStyle

Converts to this type from the input type.

impl From<Cursor> for Span

fn from(cursor: Cursor) -> Span

Converts to this type from the input type.

impl From<Cursor> for Token

fn from(cursor: Cursor) -> Token

Converts to this type from the input type.

impl From<Dash> for Cursor

fn from(value: Dash) -> Self

Converts to this type from the input type.

impl From<DashedIdent> for Cursor

fn from(value: DashedIdent) -> Self

Converts to this type from the input type.

impl From<Delim> for Cursor

fn from(value: Delim) -> Self

Converts to this type from the input type.

impl From<Dimension> for Cursor

fn from(value: Dimension) -> Self

Converts to this type from the input type.

impl From<Dollar> for Cursor

fn from(value: Dollar) -> Self

Converts to this type from the input type.

impl From<Dot> for Cursor

fn from(value: Dot) -> Self

Converts to this type from the input type.

impl From<Eof> for Cursor

fn from(value: Eof) -> Self

Converts to this type from the input type.

impl From<Eq> for Cursor

fn from(value: Eq) -> Self

Converts to this type from the input type.

impl From<Function> for Cursor

fn from(value: Function) -> Self

Converts to this type from the input type.

impl From<Gt> for Cursor

fn from(value: Gt) -> Self

Converts to this type from the input type.

impl From<Hash> for Cursor

fn from(value: Hash) -> Self

Converts to this type from the input type.

impl From<Hash> for Cursor

fn from(value: Hash) -> Self

Converts to this type from the input type.

impl From<Ident> for Cursor

fn from(value: Ident) -> Self

Converts to this type from the input type.

impl From<LeftCurly> for Cursor

fn from(value: LeftCurly) -> Self

Converts to this type from the input type.

impl From<LeftParen> for Cursor

fn from(value: LeftParen) -> Self

Converts to this type from the input type.

impl From<LeftSquare> for Cursor

fn from(value: LeftSquare) -> Self

Converts to this type from the input type.

impl From<Lt> for Cursor

fn from(value: Lt) -> Self

Converts to this type from the input type.

impl From<Number> for Cursor

fn from(value: Number) -> Self

Converts to this type from the input type.

impl From<Or> for Cursor

fn from(value: Or) -> Self

Converts to this type from the input type.

impl From<PairWiseEnd> for Cursor

fn from(value: PairWiseEnd) -> Self

Converts to this type from the input type.

impl From<PairWiseStart> for Cursor

fn from(value: PairWiseStart) -> Self

Converts to this type from the input type.

impl<I> From<ParserCheckpoint<I>> for Cursor

fn from(value: ParserCheckpoint<I>) -> Self

Converts to this type from the input type.

impl From<Percent> for Cursor

fn from(value: Percent) -> Self

Converts to this type from the input type.

impl From<Plus> for Cursor

fn from(value: Plus) -> Self

Converts to this type from the input type.

impl From<Question> for Cursor

fn from(value: Question) -> Self

Converts to this type from the input type.

impl From<RightCurly> for Cursor

fn from(value: RightCurly) -> Self

Converts to this type from the input type.

impl From<RightParen> for Cursor

fn from(value: RightParen) -> Self

Converts to this type from the input type.

impl From<RightSquare> for Cursor

fn from(value: RightSquare) -> Self

Converts to this type from the input type.

impl From<Semicolon> for Cursor

fn from(value: Semicolon) -> Self

Converts to this type from the input type.

impl From<Slash> for Cursor

fn from(value: Slash) -> Self

Converts to this type from the input type.

impl From<Star> for Cursor

fn from(value: Star) -> Self

Converts to this type from the input type.

impl From<String> for Cursor

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Tilde> for Cursor

fn from(value: Tilde) -> Self

Converts to this type from the input type.

impl From<Underscore> for Cursor

fn from(value: Underscore) -> Self

Converts to this type from the input type.

impl From<Url> for Cursor

fn from(value: Url) -> Self

Converts to this type from the input type.

impl From<Whitespace> for Cursor

fn from(value: Whitespace) -> Self

Converts to this type from the input type.

impl Hash for Cursor

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Cursor

fn cmp(&self, other: &Cursor) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

impl PartialEq<AssociatedWhitespaceRules> for Cursor

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

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

1.0.0 · Source§

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<CommentStyle> for &Cursor

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

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

1.0.0 · Source§

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<CommentStyle> for Cursor

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

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

1.0.0 · Source§

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 &Cursor

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

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

1.0.0 · Source§

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 Cursor

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

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

1.0.0 · Source§

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 &Cursor

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

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

1.0.0 · Source§

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 Cursor

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

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

1.0.0 · Source§

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<QuoteStyle> for &Cursor

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

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

1.0.0 · Source§

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<QuoteStyle> for Cursor

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

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

1.0.0 · Source§

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<Span> for Cursor

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

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

1.0.0 · Source§

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<Token> for Cursor

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

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

1.0.0 · Source§

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<char> for &Cursor

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

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

1.0.0 · Source§

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<char> for Cursor

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

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

1.0.0 · Source§

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 Cursor

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

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

1.0.0 · Source§

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 Cursor

fn partial_cmp(&self, other: &Cursor) -> Option<Ordering>

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

impl SemanticEq for Cursor

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

Returns true if self and other are semantically equal.

impl Serialize for Cursor

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl ToCursors for Cursor

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

impl ToSpan for Cursor

fn to_span(&self) -> Span

impl Copy for Cursor

impl Eq for Cursor

impl StructuralPartialEq for Cursor

Auto Trait Implementations§

impl Freeze for Cursor

impl RefUnwindSafe for Cursor

impl Send for Cursor

impl Sync for Cursor

impl Unpin for Cursor

impl UnwindSafe for Cursor

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.