Struct VPath 

pub struct VPath(/* private fields */);

A normalized, workspace-relative virtual path.

Implementations

impl VPath

pub fn root() -> VPath

Return the canonical virtual workspace root.

pub fn parse(input: &str) -> Result<VPath, VPathError>

Parse and normalize a portable virtual path.

Both slash styles are treated as separators so a path accepted on one host cannot become an escape on another. Parent components may simplify a path but may never escape the virtual root.

Errors

Returns VPathError when the input is empty, absolute, contains a NUL byte or platform prefix, or would escape the virtual root during normalization.

pub fn as_str(&self) -> &str

Return the canonical slash-separated representation.

Examples found in repository

examples/staged_release.rs (line 49)

fn main() -> Result<(), Box<dyn Error>> {
    let workspace = Workspace::new()?;
    fs::create_dir(workspace.0.join("templates"))?;
    fs::write(
        workspace.0.join("templates/service.toml"),
        b"channel = \"dev\"\n",
    )?;
    let runtime = Runtime::open(RuntimeConfig::new(&workspace.0))?;
    let code = include_str!("staged_release.monty");
    let preview = runtime.preview(RunRequest::new(code).with_detail(ReceiptDetail::Full))?;
    assert!(matches!(
        preview.decision,
        RuntimeDecision::PendingApproval(_)
    ));
    assert_eq!(preview.changed_paths, 3);
    assert!(!workspace.0.join("release").exists());
    assert_eq!(
        preview
            .changes
            .iter()
            .map(|entry| entry.path.as_str())
            .collect::<Vec<_>>(),
        ["release", "release/README.txt", "release/app.toml"]
    );
    let now = u64::try_from(SystemTime::now().duration_since(UNIX_EPOCH)?.as_millis())?;
    // A rename is a semantic risk even if it only rearranges generated files.
    // Production code must authenticate a reviewer before this trusted call.
    runtime.approve(
        preview.transaction,
        PrincipalId::digest_label("fixture-reviewer"),
        now,
        now + 30_000,
    )?;
    let committed = runtime.commit(preview.transaction, now)?;
    assert_eq!(committed.transaction, preview.transaction);
    assert!(committed.commit.is_some());
    assert_eq!(
        fs::read_to_string(workspace.0.join("release/app.toml"))?,
        "channel = \"stable\"\n"
    );
    assert_eq!(
        fs::read_to_string(workspace.0.join("release/README.txt"))?,
        "channel=stable\n"
    );
    assert!(!workspace.0.join("release/service.toml").exists());
    println!(
        "Committed {} reviewed paths: {}",
        committed.changed_paths, committed.transaction
    );
    Ok(())
}

pub fn is_root(&self) -> bool

Return whether this path denotes the virtual workspace root.

pub fn parent(&self) -> Option<VPath>

Return the normalized parent, or None for the virtual root.

pub fn file_name(&self) -> Option<&str>

Return the final path component, or None for the virtual root.

pub fn join(&self, child: &str) -> Result<VPath, VPathError>

Join and normalize a relative child path.

Errors

Returns VPathError if child is invalid or the combined path escapes the virtual root.

pub fn is_within(&self, ancestor: &VPath) -> bool

Return whether this path is equal to or below ancestor.

pub fn relative_to<'a>(&'a self, ancestor: &VPath) -> Option<&'a str>

Return the normalized relative suffix below ancestor.

pub fn rebase( &self, from: &VPath, to: &VPath, ) -> Result<Option<VPath>, VPathError>

Rebase this path from one virtual subtree to another.

Errors

Returns VPathError if the rebased path would be invalid.

Trait Implementations

impl Borrow<str> for VPath

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for VPath

fn clone(&self) -> VPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VPath

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

Formats the value using the given formatter.

impl Display for VPath

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

Formats the value using the given formatter.

impl Eq for VPath

impl Hash for VPath

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VPath

fn cmp(&self, other: &VPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for VPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VPath

fn partial_cmp(&self, other: &VPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for VPath

impl TryFrom<&str> for VPath

type Error = VPathError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<VPath, <VPath as TryFrom<&str>>::Error>

Performs the conversion.