Struct ScanRoot 

pub struct ScanRoot {
    pub path: PathBuf,
    pub origin: Origin,
    pub platform: Option<Platform>,
    pub workspace_rewrites: Vec<PathMapping>,
    /* private fields */
}

A root directory to scan with associated provenance.

Fields

path: PathBuf

Path to scan.

origin: Origin

Provenance for conversations found under this root.

platform: Option<Platform>

Optional platform hint (affects path interpretation for workspace mapping).

workspace_rewrites: Vec<PathMapping>

Optional path rewrite rules.

Implementations

impl ScanRoot

pub fn local(path: PathBuf) -> ScanRoot

Create a local scan root with default provenance.

pub const fn remote( path: PathBuf, origin: Origin, platform: Option<Platform>, ) -> ScanRoot

Create a remote scan root.

pub fn with_rewrite( self, src_prefix: impl Into<String>, dst_prefix: impl Into<String>, ) -> ScanRoot

Add a workspace rewrite rule.

pub fn with_path(&self, path: PathBuf) -> ScanRoot

Return the same root metadata pointed at a derived source path.

pub fn rewrite_workspace(&self, path: &str, agent: Option<&str>) -> String

Apply workspace rewriting rules to a path.

pub fn rewrite_workspace_linear( &self, path: &str, agent: Option<&str>, ) -> String

Apply workspace rewriting using linear search (original algorithm).

Trait Implementations

impl Clone for ScanRoot

fn clone(&self) -> ScanRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanRoot

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

Formats the value using the given formatter.