Struct PathBoundary 

pub struct PathBoundary<Marker = ()> { /* private fields */ }

A path boundary that serves as the secure foundation for validated path operations.

SUMMARY: Represent the trusted filesystem root for all strict and virtual path operations. All StrictPath/VirtualPath values derived from a PathBoundary are guaranteed to remain within this boundary.

EXAMPLE:

let boundary = PathBoundary::<()>::try_new_create("./data")?;
let file = boundary.strict_join("logs/app.log")?;
println!("{}", file.strictpath_display());

Implementations

impl<Marker> PathBoundary<Marker>

pub fn try_new<P: AsRef<Path>>(restriction_path: P) -> Result<Self>

Creates a new PathBoundary rooted at restriction_path (which must already exist and be a directory).

SUMMARY: Create a boundary anchored at an existing directory (must exist and be a directory).

PARAMETERS:

• restriction_path (AsRef<Path>): Existing directory to anchor the boundary.

RETURNS:

• Result<PathBoundary<Marker>>: New boundary whose root is canonicalized and verified to exist.

ERRORS:

• StrictPathError::InvalidRestriction: Root is missing, not a directory, or cannot be canonicalized.

EXAMPLE: Uses AsRef<Path> for maximum ergonomics, including direct TempDir support for clean shadowing patterns:

use strict_path::PathBoundary;
let tmp_dir = tempfile::tempdir()?;
let tmp_dir = PathBoundary::<()>::try_new(tmp_dir)?; // Clean variable shadowing

pub fn try_new_create<P: AsRef<Path>>(root: P) -> Result<Self>

Creates the directory if missing, then constructs a new PathBoundary.

SUMMARY: Ensure the root exists (create if missing) and construct a new boundary.

PARAMETERS:

• root (AsRef<Path>): Directory to create if needed and use as boundary root.

RETURNS:

• Result<PathBoundary<Marker>>: New boundary anchored at root.

ERRORS:

• StrictPathError::InvalidRestriction: Directory creation/canonicalization fails.

EXAMPLE: Uses AsRef<Path> for maximum ergonomics, including direct TempDir support for clean shadowing patterns:

use strict_path::PathBoundary;
let tmp_dir = tempfile::tempdir()?;
let tmp_dir = PathBoundary::<()>::try_new_create(tmp_dir)?; // Clean variable shadowing

pub fn strict_join( &self, candidate_path: impl AsRef<Path>, ) -> Result<StrictPath<Marker>>

SUMMARY: Join a candidate path to the boundary and return a validated StrictPath.

PARAMETERS:

• candidate_path (AsRef<Path>): Absolute or relative path to validate within this boundary.

RETURNS:

• Result<StrictPath<Marker>>: Canonicalized, boundary-checked path.

ERRORS:

• StrictPathError::WindowsShortName (windows), StrictPathError::PathResolutionError, StrictPathError::PathEscapesBoundary.

pub fn exists(&self) -> bool

Returns true if the PathBoundary root exists.

This is always true for a constructed PathBoundary, but we query the filesystem for robustness.

pub fn interop_path(&self) -> &OsStr

SUMMARY: Return the root path as &OsStr for AsRef<Path> interop (no allocation).

pub fn strictpath_display(&self) -> Display<'_>

Returns a Display wrapper that shows the PathBoundary root system path.

pub fn metadata(&self) -> Result<Metadata>

SUMMARY: Return filesystem metadata for the boundary root.

pub fn strict_symlink(&self, link_path: &StrictPath<Marker>) -> Result<()>

SUMMARY: Create a symbolic link at link_path pointing to this boundary’s root.

PARAMETERS:

• link_path (&StrictPath<Marker>): Destination for the symlink, within the same boundary.

RETURNS:

• io::Result<()>: Mirrors std semantics.

pub fn strict_hard_link(&self, link_path: &StrictPath<Marker>) -> Result<()>

SUMMARY: Create a hard link at link_path pointing to this boundary’s root.

PARAMETERS and RETURNS mirror strict_symlink.

pub fn read_dir(&self) -> Result<ReadDir>

SUMMARY: Read directory entries under the boundary root (discovery only).

pub fn remove_dir(&self) -> Result<()>

SUMMARY: Remove the boundary root directory (non-recursive); fails if not empty.

pub fn remove_dir_all(&self) -> Result<()>

SUMMARY: Recursively remove the boundary root directory and contents.

pub fn virtualize(self) -> VirtualRoot<Marker>

SUMMARY: Convert this boundary into a VirtualRoot for virtual path operations.

Trait Implementations

impl<Marker> AsRef<Path> for PathBoundary<Marker>

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl<Marker> Clone for PathBoundary<Marker>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Marker> Debug for PathBoundary<Marker>

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

Formats the value using the given formatter.

impl<Marker: Default> FromStr for PathBoundary<Marker>

fn from_str(path: &str) -> Result<Self, Self::Err>

Parse a PathBoundary from a string path for universal ergonomics.

Creates the directory if it doesn’t exist, enabling seamless integration with any string-parsing context (clap, config files, environment variables, etc.):

let temp_dir = tempfile::tempdir()?;
let safe_path = temp_dir.path().join("safe_dir");
let boundary: PathBoundary<()> = safe_path.to_string_lossy().parse()?;
assert!(safe_path.exists());

type Err = StrictPathError

The associated error which can be returned from parsing.

impl<Marker> Hash for PathBoundary<Marker>

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

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<Marker> Ord for PathBoundary<Marker>

fn cmp(&self, other: &Self) -> 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.

impl<Marker> PartialEq<&Path> for PathBoundary<Marker>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialEq<Path> for PathBoundary<Marker>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialEq<PathBoundary<Marker>> for VirtualRoot<Marker>

fn eq(&self, other: &PathBoundary<Marker>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialEq<PathBuf> for PathBoundary<Marker>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialEq<VirtualRoot<Marker>> for PathBoundary<Marker>

fn eq(&self, other: &VirtualRoot<Marker>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialEq for PathBoundary<Marker>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Marker> PartialOrd for PathBoundary<Marker>

fn partial_cmp(&self, other: &Self) -> 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<Marker> Eq for PathBoundary<Marker>