Skip to main content

WorkspaceRoot

Struct WorkspaceRoot 

Source
pub struct WorkspaceRoot { /* private fields */ }
Expand description

Validated authority to resolve tool paths beneath one canonical directory.

Construction resolves symlinks in the supplied host path and requires an existing directory. Model-supplied paths are never interpreted relative to the process current directory.

§TOCTOU limits

Path-based host APIs cannot make resolution and a later open or rename one atomic operation. Callers performing mutations must invoke Self::revalidate_mutation immediately before commit. Executors should additionally prefer descriptor-relative operations where a safe portable implementation is available. Unix identity checks use device/inode. The portable stable Windows metadata APIs used here provide a best-effort fingerprint instead of a file index. This capability fails closed on detected replacement, but it does not claim to eliminate every filesystem race.

Implementations§

Source§

impl WorkspaceRoot

Source

pub fn new(path: impl AsRef<Path>) -> Result<Self, WorkspacePathError>

Constructs a capability from an existing host directory.

§Errors

Returns a stable bounded error if the path is absent, is not a directory, or cannot be resolved safely.

Source

pub fn host_path(&self) -> &Path

Returns the canonical host directory represented by this capability.

Source

pub fn resolve_existing( &self, path: &str, ) -> Result<ResolvedExistingPath, WorkspacePathError>

Resolves a model path that must already exist.

The returned display path is normalized and workspace-relative. The host path is canonical and has passed a component-wise containment check against this capability.

§Errors

Rejects malformed, absolute, traversing, missing, unresolvable, or workspace-escaping paths.

Source

pub fn revalidate_existing( &self, target: &ResolvedExistingPath, ) -> Result<(), WorkspacePathError>

Revalidates an existing target immediately before opening it.

§Errors

Returns CapabilityMismatch for a value from another workspace and PathChanged if resolution or filesystem identity changed.

Source

pub fn verify_opened_existing( &self, target: &ResolvedExistingPath, metadata: &Metadata, ) -> Result<(), WorkspacePathError>

Verifies that an opened file handle identifies the resolved target.

Call this with metadata obtained from the opened file handle, not by looking up its path again. It closes the validation-to-open race for the object identity on platforms that expose stable file identifiers.

§Errors

Returns PathChanged if the opened object differs from the resolved target, or CapabilityMismatch for a token from another workspace.

Source

pub fn resolve_mutation( &self, path: &str, ) -> Result<ResolvedMutationPath, WorkspacePathError>

Resolves an existing or prospective mutation target.

The workspace root itself is not a valid mutation target. Existing targets are canonicalized. For a prospective target, the nearest existing ancestor is canonicalized, checked as a directory, and checked for workspace containment before unresolved components are appended.

§Errors

Rejects malformed, absolute, traversing, unresolvable, root-targeting, non-directory-parent, or workspace-escaping paths.

Source

pub fn revalidate_mutation( &self, target: &ResolvedMutationPath, ) -> Result<(), WorkspacePathError>

Revalidates a mutation target immediately before its commit operation.

This detects containment changes, target appearance/disappearance, and nearest-existing-ancestor replacement on supported platforms. A caller must discard the old value and resolve again after any failure.

§Errors

Returns CapabilityMismatch for a value from another workspace and a stable path error when the target no longer has the same resolution.

Trait Implementations§

Source§

impl Clone for WorkspaceRoot

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorkspaceRoot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for WorkspaceRoot

Source§

impl PartialEq for WorkspaceRoot

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WorkspaceRoot

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more