Skip to main content

RendererSignal

Enum RendererSignal 

Source
pub enum RendererSignal {
    ThemeChanged,
    Quit,
    NerdFontsToggled,
    LspConfigChanged(String),
    DisplayBuffer(Box<DisplayBufferRequest>),
}
Expand description

Host-to-renderer side-effect signal.

v1 scope is deliberately small (see phase-5-dispatch-extraction.md §“RendererSignal scope”). Only variants with planned emission sites in the existing dispatch path are included; speculative variants (Repaint, TitleChanged) are deferred until a real need surfaces.

The renderer matches on this in its post-dispatch hook:

ⓘ
let outcome = self.editor.dispatch(action);
for signal in outcome.renderer_signals {
    match signal {
        RendererSignal::ThemeChanged => self.rebuild_renderer_theme(),
        RendererSignal::Quit => self.shutdown(),
    }
}

First emission sites land in sub-slices 5.5.C (Self::Quit) and 5.5.E (Self::ThemeChanged); the variants exist from 5.5.A so the type surface is fixed before any consumer composes against it.

Variants§

§

ThemeChanged

The host’s neutral [crate::ui::theme::Theme] changed (typically via a :set ui.* cascade). The renderer should rebuild its cached typed theme mirror.

§

Quit

Quit requested. The renderer should begin its shutdown sequence. editor.should_quit is also set for back-compat with renderers that poll per-tick.

§

NerdFontsToggled

5.5.E.6: the ui.nerd_fonts cascade flipped the nerd-fonts toggle. The TUI’s file-tree rope embeds the icon glyphs, so a palette flip needs a per-file-tree-buffer rope refresh on the renderer side; oil’s renderer reads the toggle each frame and needs no rope-side work. The host emits this in addition to Self::ThemeChanged so renderers that don’t track file-tree state can ignore it without missing the theme rebuild.

§

LspConfigChanged(String)

5.5.E.6: the option-cascade just touched an lsp.<server_id>.* key. The renderer fans out a workspace/didChangeConfiguration to every actor matching server_id with the freshly merged subtree. The host can’t drive this without owning the LSP actor pool, which stays renderer-side through 5.5.

§

DisplayBuffer(Box<DisplayBufferRequest>)

5.5.F.1: a host-side do_* arm built a lattice_help::HelpContent and wants the renderer to display it under a given category (e.g. Effect::ListBuffers → HelpList, Effect::DescribeBuffer → HelpDescribe). The renderer runs its existing display_buffer dispatch: resolve the category to a lattice_core::ui::display::BufferDisplay preference, then route into the matching surface (popup, active-pane swap, split). Boxed because lattice_help::HelpContent is ~6 fields including a parsed markdown highlight cache, and most signals don’t carry one — keeping the variant small keeps the common-case Vec<RendererSignal> cheap. PartialEq / Eq derives drop on RendererSignal because lattice_help::HelpContent doesn’t implement them (the syntax-highlight cache is renderer-neutral but not value- equatable). Signals are produced at : / Effect-arm rate, not per-frame, so the Box allocation is well below any perf gate.

Trait Implementations§

Source§

impl Clone for RendererSignal

Source§

fn clone(&self) -> RendererSignal

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

impl Debug for RendererSignal

Source§

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

Formats the value using the given formatter. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoMaybeUndefined<T> for T

§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
§

impl<T> IntoOption<T> for T

§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Pointer = u32

§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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