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 synthetic_placeholder: bool,
    pub is_preview: 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)

synthetic_placeholder: bool

Whether this buffer is a synthetic placeholder created when the user closed their last buffer with auto_create_empty_buffer_on_last_buffer_close disabled. The editor’s invariants require at least one buffer at all times, so we keep this one around but render the split pane as blank (no line numbers, no ~ filler) and hide it from tabs to give the user a truly empty workspace.

is_preview: bool

Whether this buffer is opened in “preview” mode (ephemeral). A preview buffer is one opened by a single-click in the file explorer (or a similar soft-open gesture). Its tab is rendered in italic and it is replaced the next time another file is opened the same way. The flag is cleared (“promoted”) when the user edits the buffer, double-clicks the file, or otherwise signals commitment to the file.

Intentionally ephemeral — never serialized into workspace or recovery state. Restarting the editor always brings buffers back as permanent tabs; preview status belongs to the current session’s exploration flow only.

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<&LspUri>

Get the LSP-facing URI if this is a file-backed buffer.

The URI is already translated for the active authority — i.e. it carries the in-container path on a devcontainer authority and the host path elsewhere. Hand it to the LSP server directly; do NOT pass it to filesystem APIs (use Self::file_path for that).

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( canonical_path: PathBuf, display_path: &Path, working_dir: &Path, path_translation: Option<&PathTranslation>, ) -> Self

Create metadata for a file-backed buffer

Arguments

• canonical_path - The canonical (symlink-resolved) absolute path to the file
• display_path - The user-visible path before canonicalization (for library detection)
• working_dir - The canonical working directory for computing relative display name
• path_translation - Active authority’s host↔remote workspace mapping; used to build the LSP-facing file_uri so an in-container LSP sees in-container paths. None for local/SSH authorities.

pub fn with_container_file(container_path: PathBuf, uri: LspUri) -> Self

Create metadata for a buffer fetched from inside a container.

Used by Editor::open_lsp_uri_target when a Goto-Definition (or similar) URI lands on a path that exists only inside the container — typically a stdlib / site-packages entry that isn’t bind-mounted onto the host. The buffer is read-only because there’s no host-side writeback path; LSP stays enabled so further navigation from the fetched buffer (hover, more goto-defs) keeps working.

The supplied uri is the wire URI the LSP returned (already in container-side coordinates) and is cached verbatim — no host→remote translation, because the path is the remote path. The display name is the file name, since the container path has nothing to relativize against the host working dir.

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.