Struct watchman_client::ResolvedRoot

pub struct ResolvedRoot { /* fields omitted */ }

Data that describes a watched filesystem location. Watchman performs watch aggregation to project boundaries, so a request to watch a subdirectory will resolve to the higher level root path and a relative path offset. This struct encodes both pieces of information.

Implementations

impl ResolvedRoot

pub fn watcher(&self) -> &str

Returns the name of the watcher that the server is using to monitor the path. The watcher is generally system dependent, but some systems offer multipler watchers. You generally don't care too much about the watcher that is in use, but if the watcher is a virtualized filesystem such as eden then you may wish to use to alternative queries to get the best performance.

pub fn project_root(&self) -> &Path

Returns the root of the watchman project that is being watched

pub fn path(&self) -> PathBuf

Returns the absolute path to the directory that you requested be resolved.

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

Returns the path to the directory that you requested be resolved, relative to the project_root.

Trait Implementations

impl Clone for ResolvedRoot

fn clone(&self) -> ResolvedRoot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedRoot

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

Formats the value using the given formatter.