Struct BufferMetadata 

pub struct BufferMetadata {
    pub kind: BufferKind,
    pub display_name: String,
    pub lsp_enabled: bool,
    pub lsp_disabled_reason: Option<String>,
    pub read_only: bool,
    pub binary: bool,
    pub lsp_opened_with: HashSet<u64>,
    pub hidden_from_tabs: bool,
    pub recovery_id: Option<String>,
}

Metadata associated with a buffer

Fields

kind: BufferKind

The kind of buffer (file or virtual)

display_name: String

Display name for the buffer (project-relative path or filename or BufferName)

lsp_enabled: bool

Whether LSP is enabled for this buffer (always false for virtual buffers)

lsp_disabled_reason: Option<String>

Reason LSP is disabled (if applicable)

read_only: bool

Whether the buffer is read-only (typically true for virtual buffers)

binary: bool

Whether the buffer contains binary content Binary buffers are automatically read-only and render unprintable chars as code points

lsp_opened_with: HashSet<u64>

LSP server instance IDs that have received didOpen for this buffer. Used to ensure didOpen is sent before any requests to a new/restarted server. When a server restarts, it gets a new ID, so didOpen is automatically resent. Old IDs are harmless - they just remain in the set but don’t match any active server.

hidden_from_tabs: bool

Whether this buffer should be hidden from tabs (used for composite source buffers)

recovery_id: Option<String>

Stable recovery ID for unnamed buffers. For file-backed buffers, recovery ID is computed from the path hash. For unnamed buffers, this is generated once and reused across auto-saves.

Implementations

impl BufferMetadata

pub fn file_path(&self) -> Option<&PathBuf>

Get the file path if this is a file-backed buffer

pub fn file_uri(&self) -> Option<&Uri>

Get the file URI if this is a file-backed buffer

pub fn is_virtual(&self) -> bool

Check if this is a virtual buffer

pub fn virtual_mode(&self) -> Option<&str>

Get the mode name for virtual buffers

impl BufferMetadata

pub fn new() -> Self

Create new metadata for a buffer (unnamed, file-backed)

pub fn new_unnamed(display_name: String) -> Self

Create new metadata for an unnamed buffer with a custom display name Used for buffers created from stdin or other non-file sources

pub fn with_file(path: PathBuf, working_dir: &Path) -> Self

Create metadata for a file-backed buffer

Arguments

• path - The canonical absolute path to the file
• working_dir - The canonical working directory for computing relative display name

pub fn is_library_path(path: &Path, _working_dir: &Path) -> bool

Check if a path is a library file (in vendor directories or standard libraries)

Library files include:

• Files in common vendor/dependency directories (.cargo, node_modules, etc.)
• Standard library / toolchain files (rustup toolchains, system includes, etc.)

pub fn display_name_for_path(path: &Path, working_dir: &Path) -> String

Compute display name relative to working_dir when possible, otherwise absolute

pub fn virtual_buffer(name: String, mode: String, read_only: bool) -> Self

Create metadata for a virtual buffer (not backed by a file)

Arguments

• name - Display name (e.g., “Diagnostics”)
• mode - Buffer mode for keybindings (e.g., “diagnostics-list”)
• read_only - Whether the buffer should be read-only

pub fn hidden_virtual_buffer(name: String, mode: String) -> Self

Create metadata for a hidden virtual buffer (for composite source buffers) These buffers are not shown in tabs and are managed by their parent composite buffer. Hidden buffers are always read-only to prevent accidental edits.

pub fn disable_lsp(&mut self, reason: String)

Disable LSP for this buffer with a reason

Trait Implementations

impl Clone for BufferMetadata

fn clone(&self) -> BufferMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferMetadata

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

Formats the value using the given formatter.

impl Default for BufferMetadata

fn default() -> Self

Returns the “default value” for a type.