Struct HighlightSpan 

pub struct HighlightSpan { /* private fields */ }

A highlight span attached to a byte range of source text.

use dioxus_code::advanced::HighlightSpan;
let span = HighlightSpan::new(0..2, "k");
assert_eq!(span.tag(), "k");

Implementations

impl HighlightSpan

pub const fn new(range: Range<u32>, tag: &'static str) -> Self

Create a highlight span.

use dioxus_code::advanced::HighlightSpan;
let span = HighlightSpan::new(0..2, "k");
assert_eq!(span.range(), 0..2);

pub const fn from_offsets(start: u32, end: u32, tag: &'static str) -> Self

Create a highlight span from explicit byte offsets.

use dioxus_code::advanced::HighlightSpan;
let span = HighlightSpan::from_offsets(0, 2, "k");
assert_eq!(span.start(), 0);

pub const fn start(self) -> u32

Byte offset, inclusive, of the span’s start in the source.

use dioxus_code::advanced::HighlightSpan;
assert_eq!(HighlightSpan::new(3..5, "k").start(), 3);

pub const fn end(self) -> u32

Byte offset, exclusive, of the span’s end in the source.

use dioxus_code::advanced::HighlightSpan;
assert_eq!(HighlightSpan::new(3..5, "k").end(), 5);

pub const fn range(self) -> Range<u32>

Byte range covered by this span.

use dioxus_code::advanced::HighlightSpan;
assert_eq!(HighlightSpan::new(3..5, "k").range(), 3..5);

pub const fn tag(self) -> &'static str

Highlight tag class suffix, for example "k" for keywords.

use dioxus_code::advanced::HighlightSpan;
assert_eq!(HighlightSpan::new(0..2, "k").tag(), "k");

Trait Implementations

impl Clone for HighlightSpan

fn clone(&self) -> HighlightSpan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightSpan

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

Formats the value using the given formatter.

impl PartialEq for HighlightSpan

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

impl Eq for HighlightSpan

impl StructuralPartialEq for HighlightSpan