Struct HighlightSegment 

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

A borrowed render segment with an optional highlight tag.

use dioxus_code::advanced::HighlightSegment;
let segment = HighlightSegment::new("fn", Some("k"));
assert_eq!(segment.text(), "fn");

Implementations

impl<'a> HighlightSegment<'a>

pub const fn new(text: &'a str, tag: Option<&'static str>) -> Self

Create a highlighted segment.

use dioxus_code::advanced::HighlightSegment;
let _segment = HighlightSegment::new("fn", Some("k"));

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

The source text for this segment.

use dioxus_code::advanced::HighlightSegment;
assert_eq!(HighlightSegment::new("fn", Some("k")).text(), "fn");

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

Highlight tag class suffix, when this segment is highlighted.

use dioxus_code::advanced::HighlightSegment;
assert_eq!(HighlightSegment::new("fn", Some("k")).tag(), Some("k"));

Trait Implementations

impl<'a> Clone for HighlightSegment<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HighlightSegment<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for HighlightSegment<'a>

fn eq(&self, other: &HighlightSegment<'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> Copy for HighlightSegment<'a>

impl<'a> Eq for HighlightSegment<'a>

impl<'a> StructuralPartialEq for HighlightSegment<'a>