Struct SourceCode 

pub struct SourceCode { /* private fields */ }

Available on crate feature runtime only.

Source text to highlight at runtime.

Available with the runtime feature. Build one with SourceCode::new, then pass it to Code().

use dioxus_code::{Language, SourceCode};
let _src = SourceCode::new(Language::Rust, "fn main() {}");

Implementations

impl SourceCode

pub fn new(language: Language, source: impl ToString) -> Self

Wrap a raw source string with an explicit language.

use dioxus_code::{Language, SourceCode};
let _src = SourceCode::new(Language::Rust, "fn main() {}");

pub fn with_language(self, language: Language) -> Self

Replace the language used to highlight this source.

To set the language from a runtime slug, use Language::from_slug and pass the resulting variant.

use dioxus_code::{Language, SourceCode};
let _src = SourceCode::new(Language::Rust, "fn main() {}").with_language(Language::Rust);

pub fn highlight(self) -> Result<HighlightedSource, HighlightError>

Highlight this source, returning typed errors when runtime highlighting fails.

Use Into<HighlightedSource> for the lossy rendering path that discards the error and renders plaintext.

Trait Implementations

impl Clone for SourceCode

fn clone(&self) -> SourceCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceCode

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

Formats the value using the given formatter.

impl From<SourceCode> for HighlightedSource

fn from(code: SourceCode) -> Self

Converts to this type from the input type.

impl PartialEq for SourceCode

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

impl StructuralPartialEq for SourceCode