Struct SnippetSession 

pub struct SnippetSession { /* private fields */ }

The live snippet sessions, keyed by the buffer each is expanding in (a buffer is absent from the map when no snippet is live there).

Implementations

impl SnippetSession

pub fn new() -> Self

pub fn is_active(&self, buffer: BufferId) -> bool

true while a snippet is expanding in buffer. Backs the host’s many readers (keymap overlay sync, render state, …), each of which names the buffer it cares about so a session in one buffer never activates the mode in another.

pub fn set(&self, buffer: BufferId, active: ActiveSnippet)

Install a freshly-expanded session in buffer, replacing any prior session for that same buffer.

pub fn clear(&self, buffer: BufferId)

End the session in buffer (reached $0, or the buffer/mode tore down). A no-op if buffer had no live session.

pub fn with_mut<R>( &self, buffer: BufferId, f: impl FnOnce(&mut Option<ActiveSnippet>) -> R, ) -> R

Mutate the live session for buffer in place. The closure sees an Option so it can advance the focused tabstop and end the session (set it to None) in one critical section — setting it to None removes the buffer’s entry from the map.

Trait Implementations

impl Debug for SnippetSession

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

Formats the value using the given formatter.

impl Default for SnippetSession

fn default() -> SnippetSession

Returns the “default value” for a type.