Skip to main content

SyntaxWorker

Struct SyntaxWorker 

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

Background worker that owns the Highlighter and the retained tree-sitter Tree. Communicates with the main thread via a Mutex<Pending> + Condvar for submits, and an mpsc channel for rendered output.

§Examples

use std::sync::Arc;
use hjkl_syntax::SyntaxWorker;
use hjkl_bonsai::DotFallbackTheme;
use hjkl_lang::LanguageDirectory;

let theme = Arc::new(DotFallbackTheme::dark());
let dir = Arc::new(LanguageDirectory::new().unwrap());
let worker = SyntaxWorker::spawn(theme, dir);
drop(worker); // joins the thread

Implementations§

Source§

impl SyntaxWorker

Source

pub fn spawn( theme: Arc<dyn Theme + Send + Sync>, directory: Arc<LanguageDirectory>, ) -> Self

Spawn a fresh worker thread with the given theme and language directory.

Source

pub fn set_language(&self, id: BufferId, grammar: Option<Arc<Grammar>>)

Set / replace the highlighter for a buffer. None detaches.

Source

pub fn forget(&self, id: BufferId)

Forget all worker state for a buffer (highlighter + tree). Sent on buffer close.

Source

pub fn set_theme(&self, theme: Arc<dyn Theme + Send + Sync>)

Replace the theme used for capture → style resolution.

Source

pub fn try_recv_latest(&self) -> Option<RenderOutput>

Drain all available render results, returning the most recent one. Earlier results are discarded — they’d just be overwritten by the latest install anyway, and this keeps the install path O(1) per frame regardless of backlog depth.

Source

pub fn try_recv_all(&self) -> Vec<RenderOutput>

Drain all available render results, returning them all (one per (buffer_id, kind) pair that completed). Unlike Self::try_recv_latest this does not discard earlier results — required so pre-warmed results for non-active buffers can be routed to the right slot cache.

Source

pub fn wait_for_latest(&self, timeout: Duration) -> Option<RenderOutput>

Wait up to timeout for the next result, then drain anything else that arrived after it and return the latest.

Source

pub fn wait_then_recv_all(&self, timeout: Duration) -> Vec<RenderOutput>

Wait up to timeout for the first result to arrive, then drain every additional result already in the channel. Returns ALL results in arrival order (latest per (buffer_id, kind) coalesced).

Unlike Self::wait_for_latest this does NOT discard earlier results — required when pre-warming non-active buffers so both the active buffer’s result and pre-warm results reach their slot caches.

Trait Implementations§

Source§

impl Drop for SyntaxWorker

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more