Skip to main content

ModelineElementUpdate

Struct ModelineElementUpdate 

Source
pub struct ModelineElementUpdate {
    pub key: ModelineKey,
    pub id: ElementId,
    pub content: ElementContent,
}
Expand description

A typed event a producer (mode / plugin) publishes on the event bus to set an element’s content (ML.3). The host forwarder fires the §12 render-wake on arrival; the actor thread drains the event into the content store in run_tick_pending (single-writer). Empty content hides the element (the drain treats it as a ModelineService::clear).

This is the WIT-shaped push path: native modes and (later) plugins update content the same way, so no producer is invoked on the render path (paramount #1, §2 / §5). See docs/dev/architecture/modeline.md §5 (update flow), §6 (ownership).

§Examples

A producer publishes from anywhere it holds the bus — an on_activate hook, a spawned task — never from the render path:

use lattice_core::BufferId;
use lattice_mode::{
    ElementContent, ElementId, ModelineElementUpdate, ModelineKey, ModelineRole,
    ModelineService,
};
use lattice_runtime::EventBus;

let bus = EventBus::new();
let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
bus.subscribe_typed::<ModelineElementUpdate>(tx); // the host forwarder

bus.publish_typed(ModelineElementUpdate {
    key: ModelineKey::Buffer(BufferId(1)),
    id: ElementId::new("my-plugin.status"),
    content: ElementContent::text("● synced", ModelineRole::new("modeline.mode_item")),
});

// The host drains it into the content store on the actor thread.
let service = ModelineService::new();
service.apply(rx.try_recv().unwrap());
let got = service.snapshot();
let got = got.content_for(ModelineKey::Buffer(BufferId(1)), &ElementId::new("my-plugin.status"));
assert_eq!(got.unwrap().plain(), "● synced");

Fields§

§key: ModelineKey

Which slot: a buffer’s (pane-local element) or the global one.

§id: ElementId

The element whose content this sets.

§content: ElementContent

The new content; empty clears the slot and hides the element.

Trait Implementations§

Source§

impl Clone for ModelineElementUpdate

Source§

fn clone(&self) -> ModelineElementUpdate

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 ModelineElementUpdate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Event for ModelineElementUpdate

Source§

fn event_type_id(&self) -> EventTypeId

The type-id under which this event is registered. Implementors typically delegate to a static to avoid re-allocating the metadata on every call. The macro register_event! generates this for you.

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.

§

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