Struct BufferStates 

pub struct BufferStates<S> { /* private fields */ }

Per-buffer state for one magit mode.

One instance per state type, registered as a service at install time. Entries are published by on_activate and removed when the buffer’s mode guard drops, so a stale entry cannot outlive its buffer.

Implementations

impl<S> BufferStates<S>

pub fn publish(&self, buffer: BufferId, state: S) -> Arc<Mutex<S>>

Publish state for buffer, replacing any prior entry (a re-activation on the same buffer supersedes the old state). Returns the shared handle so the caller can keep mutating it after an await — see the module note on late-resolved fields.

pub fn publish_shared(&self, buffer: BufferId, state: Arc<Mutex<S>>)

Publish an already-shared state handle.

The peer of Self::publish for a mode that already owns an Arc<Mutex<S>> (magit-status builds one for its fold source before publishing).

pub fn get(&self, buffer: BufferId) -> Option<Arc<Mutex<S>>>

The state for buffer, or None when no magit mode of this type is live on it. Handlers treat None as “not mine” and no-op — the same outcome as before, minus the race.

pub fn remove(&self, buffer: BufferId)

pub fn all(&self) -> Vec<Arc<Mutex<S>>>

Every live state of this type, in no particular order.

MG.21c: for handlers that must reach their mode’s buffers without being able to name one. A prompt’s -finish action fires with the PROMPT buffer’s buffer_id (see Editor::do_prompt_line_submit), so Self::get and state_for both return None there — but the work it just did still has to show up. Services are reachable from any context, so the finish handler refreshes through this instead.

Trait Implementations

impl<S> Default for BufferStates<S>

fn default() -> Self

Returns the “default value” for a type.