Struct Document 

pub struct Document {
    pub buf: Buffer,
    pub indent: Indent,
    pub source: DocumentSource,
}

Fields

buf: Buffer

indent: Indent

Resolved at open/reload (config default or content-detected).

source: DocumentSource

What backs this document (0021 §4): the surface payload lives in the source variant; readonly derives from it at construction.

Implementations

impl Document

pub fn remote(buffer: Buffer, source: RemoteDocument) -> Self

pub fn directory(buffer: Buffer, source: RemoteDirectory) -> Self

pub fn remote_metadata(&self) -> Option<&RemoteDocument>

pub fn directory_metadata_ref(&self) -> Option<&RemoteDirectory>

impl Document

pub fn new(buf: Buffer) -> Self

pub fn scratch(buf: Buffer) -> Self

A scratch document (no file).

pub fn surface(buf: Buffer, surface: Surface, context: GitContext) -> Self

A git-memory surface: job-owned content, readonly derived from the source — not set by hand (0021 §4).

pub fn output(buf: Buffer) -> Self

Named virtual content (:!cmd output, help, the undo browser): readonly derived from the source.

pub fn container_file( buf: Buffer, container: ContainerId, path: PathBuf, ) -> Self

A file read from a container (0037 DC1a/b): readonly derived from the source; the path names container bytes, never a local file.

pub fn syntax_path(&self) -> Option<&Path>

Syntax identity is data; parsers live on the display-analysis worker.

pub fn matches_target(&self, target: &FileTarget) -> bool

pub fn surface_payload(&self) -> Option<&Surface>

The surface payload, when this document is one.

pub fn surface_payload_mut(&mut self) -> Option<&mut Surface>

Mutable surface payload, when this document is one.