Struct BufferScopeDir 

pub struct BufferScopeDir(pub PathBuf);

The directory a buffer is about, when that is not its own path.

A magit status buffer, an oil listing, a file tree, a search or agenda view — none of them is a file, so none has a path, and every one of them still belongs somewhere. Without this the editor’s project resolution takes its only other branch and answers with the process working directory, so :files in a magit buffer for ~/work/api listed whatever tree the editor happened to be launched in.

A directory, not a project root

The writer records where the buffer is; the host resolves that to a project through the ordinary ProjectResolverHandle. So an oil buffer on /repo/src records /repo/src and :files still lists /repo — the provider does not have to know what a project is, and the two notions cannot drift apart by being recorded twice.

Universal, hence text-mode

Owned by no single mode, like text-mode.extra-highlights: any buffer may have one and most do not. Written through ModeActivator::set_buffer_scope_dir so a provider sets it from its trigger, where it already knows the answer.

Tuple Fields

0: PathBuf

Trait Implementations

impl BufferLocal for BufferScopeDir

const NAME: &'static str = "text-mode.scope-dir"

Public display name (:describe-buffer row label, debug logs). Convention: <owner-mode-name>.<key>, e.g. "file-tree.entries". Not a registry key — locals aren’t registered globally; the name is metadata for inspection.

const DOC: &'static str = "The directory this buffer is about, for a buffer that is not \ itself a file — a magit repository, an oil listing's directory, a \ file tree's root, a search or agenda view's scan root. Project \ resolution (`:files`, `:search`) reads it before falling back to \ the buffer's own path, and then to the working directory."

Doc string. Shown in :describe-buffer when the user expands a local for detail.

const OWNER_MODE: &'static str = "text-mode"

Mode id that owns this local. Attribution metadata for :describe-buffer; the write-time check the design calls for (a ModeContext::set_local::<T> that rejects a non-owner) is not implemented, so nothing enforces it today (see the module docs).

fn describe(&self) -> String

Single-line summary of the local’s value for :describe-buffer’s tabular display. Implementations should be cheap (no heavy formatting); detailed inspection is via the mode’s own commands.

impl Clone for BufferScopeDir

fn clone(&self) -> BufferScopeDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferScopeDir

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

Formats the value using the given formatter.

impl Eq for BufferScopeDir

impl PartialEq for BufferScopeDir

fn eq(&self, other: &BufferScopeDir) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BufferScopeDir