Skip to main content

HighlightEngine

Struct HighlightEngine 

Source
pub struct HighlightEngine { /* private fields */ }
Expand description

A cheap-to-clone, Send + Sync handle to a grammar + theme for off-thread bulk tokenization. Nothing syntect crosses its surface; SegmentBoundary and SegmentTokens are opaque. Obtain via HighlightCache::engine (to share the cache’s exact grammar/theme) or HighlightEngine::new, and move clones to worker threads.

Implementations§

Source§

impl HighlightEngine

Source

pub fn new(syntax: SyntaxDef, theme: TokenTheme) -> Self

An engine over an injected grammar + theme (mirrors Highlighter::new).

Source

pub fn fresh_boundary(&self) -> SegmentBoundary

The document-top fresh start state, as a boundary. The coordinator compares a segment’s guessed Fresh start against a prior segment’s true end with this: equal => the guess was right, the segment verifies as-is; unequal => re-run from the true end.

Trait Implementations§

Source§

impl Clone for HighlightEngine

Source§

fn clone(&self) -> HighlightEngine

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.