Struct EditorStateSnapshot 

pub struct EditorStateSnapshot {

    pub active_buffer_id: BufferId,
    pub active_split_id: usize,
    pub buffers: HashMap<BufferId, BufferInfo>,
    pub buffer_saved_diffs: HashMap<BufferId, BufferSavedDiff>,
    pub primary_cursor: Option<CursorInfo>,
    pub all_cursors: Vec<CursorInfo>,
    pub viewport: Option<ViewportInfo>,
    pub buffer_cursor_positions: HashMap<BufferId, usize>,
    pub buffer_text_properties: HashMap<BufferId, Vec<TextProperty>>,
    pub selected_text: Option<String>,
    pub clipboard: String,
    pub working_dir: PathBuf,
    pub diagnostics: HashMap<String, Vec<Diagnostic>>,
    pub config: Value,
    pub user_config: Value,
    pub editor_mode: Option<String>,
}

Snapshot of editor state for plugin queries This is updated by the editor on each loop iteration

Fields

active_buffer_id: BufferId

Currently active buffer ID

active_split_id: usize

Currently active split ID

buffers: HashMap<BufferId, BufferInfo>

Information about all open buffers

buffer_saved_diffs: HashMap<BufferId, BufferSavedDiff>

Diff vs last saved snapshot for each buffer (line counts may be unknown)

primary_cursor: Option<CursorInfo>

Primary cursor position for the active buffer

all_cursors: Vec<CursorInfo>

All cursor positions for the active buffer

viewport: Option<ViewportInfo>

Viewport information for the active buffer

buffer_cursor_positions: HashMap<BufferId, usize>

Cursor positions per buffer (for buffers other than active)

buffer_text_properties: HashMap<BufferId, Vec<TextProperty>>

Text properties per buffer (for virtual buffers with properties)

selected_text: Option<String>

Selected text from the primary cursor (if any selection exists) This is populated on each update to avoid needing full buffer access

clipboard: String

Internal clipboard content (for plugins that need clipboard access)

working_dir: PathBuf

Editor’s working directory (for file operations and spawning processes)

diagnostics: HashMap<String, Vec<Diagnostic>>

LSP diagnostics per file URI Maps file URI string to Vec of diagnostics for that file

config: Value

Runtime config as serde_json::Value (merged user config + defaults) This is the runtime config, not just the user’s config file

user_config: Value

User config as serde_json::Value (only what’s in the user’s config file) Fields not present here are using default values

editor_mode: Option<String>

Global editor mode for modal editing (e.g., “vi-normal”, “vi-insert”) When set, this mode’s keybindings take precedence over normal key handling

Implementations

impl EditorStateSnapshot

pub fn new() -> EditorStateSnapshot

Trait Implementations

impl Clone for EditorStateSnapshot

fn clone(&self) -> EditorStateSnapshot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EditorStateSnapshot

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

Formats the value using the given formatter.

impl Default for EditorStateSnapshot

fn default() -> EditorStateSnapshot

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EditorStateSnapshot

fn deserialize<__D>( __deserializer: __D, ) -> Result<EditorStateSnapshot, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EditorStateSnapshot

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for EditorStateSnapshot

type WithoutGenerics = EditorStateSnapshot

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = EditorStateSnapshot

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where EditorStateSnapshot: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where EditorStateSnapshot: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.