Struct MarkerResolver 

pub struct MarkerResolver { /* private fields */ }

The built-in ProjectResolver: walk up for a marker, else pwd.

Examples

use lattice_core::{MarkerResolver, ProjectKind, ProjectResolver};

let root = std::env::temp_dir().join(format!("lattice-doc-project-{}", std::process::id()));
std::fs::create_dir_all(root.join("src"))?;
std::fs::write(root.join("Cargo.toml"), "")?;

let resolver = MarkerResolver::with_default_markers(std::env::temp_dir());
// A file that does not exist yet still resolves, via its parent.
let project = resolver.for_path(&root.join("src/main.rs"));
assert_eq!(project.root, root);
assert_eq!(project.kind, ProjectKind::Marker("Cargo.toml".into()));
assert!(project.is_rooted());

Implementations

impl MarkerResolver

pub fn new(markers: Vec<String>, pwd: PathBuf) -> Self

Build a resolver over markers, falling back to pwd.

The marker list arrives as a parameter rather than being read from a typed option here because lattice-config depends on this crate — core cannot name the option type. The host reads project.root-markers and passes it in, which is also what keeps this crate free of a config dependency for one Vec<String>.

pub fn with_default_markers(pwd: PathBuf) -> Self

The default marker set (DEFAULT_ROOT_MARKERS) over pwd.

Trait Implementations

impl Debug for MarkerResolver

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

Formats the value using the given formatter.

impl ProjectResolver for MarkerResolver

fn for_path(&self, path: &Path) -> Project

The project containing path, which may be a file or a directory. Total — see the module docs.

fn set_pwd(&self, pwd: PathBuf)

Re-point the working directory the ProjectKind::Pwd fallback uses. Called on :cd. Drops the cache, because entries that fell back to the old pwd are now wrong.

fn set_markers(&self, markers: Vec<String>)

Replace the marker set. Called when project.root-markers changes, and at boot once config has been applied.

fn invalidate(&self)

Drop every cached answer — :project-refresh, after a git init mid-session. The cache is an optimisation and never a source of truth, so this changes latency and nothing else.