Struct HighlightedSource 

pub struct HighlightedSource { /* private fields */ }

A highlighted source string with metadata and token spans.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("let x = 1;", Language::Rust, &[]);
assert_eq!(src.source(), "let x = 1;");

Implementations

impl HighlightedSource

pub const fn from_static_parts( source: &'static str, language: Language, spans: &'static [HighlightSpan], ) -> Self

Build highlighted source from static text and spans.

This is mainly useful for compile-time highlighters and macro output.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("let x = 1;", Language::Rust, &[]);
assert_eq!(src.language(), Language::Rust);

pub fn source(&self) -> &str

The raw source text.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("hello", Language::Rust, &[]);
assert_eq!(src.source(), "hello");

pub const fn language(&self) -> Language

The detected or explicitly set language, if any.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("", Language::Rust, &[]);
assert_eq!(src.language(), Language::Rust);

pub fn spans(&self) -> &[HighlightSpan]

The highlight spans covering the source.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("", Language::Rust, &[]);
assert!(src.spans().is_empty());

pub fn segments(&self) -> Vec<HighlightSegment<'_>>

Split the source into renderable highlighted segments.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("hello", Language::Rust, &[]);
assert_eq!(src.segments().len(), 1);

pub fn lines(&self) -> Vec<Vec<HighlightSegment<'_>>>

Split the source into highlighted lines.

Trailing empty lines are preserved so editor renderers can keep line numbers and input rows aligned with the original source text.

use dioxus_code::Language;
use dioxus_code::advanced::HighlightedSource;
let src = HighlightedSource::from_static_parts("a\nb", Language::Rust, &[]);
assert_eq!(src.lines().len(), 2);

Trait Implementations

impl Clone for HighlightedSource

fn clone(&self) -> HighlightedSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightedSource

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

Formats the value using the given formatter.

impl From<SourceCode> for HighlightedSource

Available on crate feature runtime only.

fn from(code: SourceCode) -> Self

Converts to this type from the input type.

impl PartialEq for HighlightedSource

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

impl StructuralPartialEq for HighlightedSource