Skip to main content

ModeEvent

Enum ModeEvent 

Source
pub enum ModeEvent {
    ModeActivationFailed {
        buffer: BufferId,
        mode: ModeId,
        reason: String,
    },
    OptionConflict {
        buffer: BufferId,
        option: &'static str,
        modes: SmallVec<[ModeId; 2]>,
    },
}
Expand description

Internal mode-dispatch signals on the typed event bus (ModeActivationFailed / OptionConflict). The observable lifecycle quartet lives on the [lattice_protocol::Event] enum (MA.1) — see the module docs.

Variants§

§

ModeActivationFailed

on_activate returned Err. Published from the spawned lifecycle task instead of the success lifecycle event. active_modes was mutated synchronously by the dispatcher’s sync prefix; M-async.3 adds an App-side subscriber that rolls back on this event. reason is the boundary string of the original ModeActivationError (the error type itself isn’t Eq / Clone-friendly across crate boundaries; the string is what subscribers actually use) (M-async.2).

Fields

§buffer: BufferId

The buffer the activation targeted.

§mode: ModeId

The mode whose hook failed, or a later cascade step that never ran.

§reason: String

The error’s display string; for a skipped cascade step, "cascade aborted by <mode>".

§

OptionConflict

Two active minor modes contributed conflicting values for the same option. Reserved: declared for M.2’s resolver, but nothing publishes it today.

Fields

§buffer: BufferId

The buffer whose resolution saw the conflict.

§option: &'static str

The option’s canonical name.

§modes: SmallVec<[ModeId; 2]>

The minors that disagree.

Implementations§

Source§

impl ModeEvent

Source

pub fn activation_failed( buffer: BufferId, mode: ModeId, err: &ModeActivationError, ) -> Self

Build a ModeActivationFailed from a ModeActivationError. Stringifies the error so the event payload is Clone + Eq (the error variants contain registry-internal types that aren’t worth threading through every subscriber).

Trait Implementations§

Source§

impl Clone for ModeEvent

Source§

fn clone(&self) -> ModeEvent

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 ModeEvent

Source§

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

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

impl Eq for ModeEvent

Source§

impl Event for ModeEvent

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

impl PartialEq for ModeEvent

Source§

fn eq(&self, other: &ModeEvent) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ModeEvent

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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