Struct SafePath 

pub struct SafePath { /* private fields */ }

Data-only type for safe path handling. Centralized under crate::types for cross-layer reuse.

Implementations

impl SafePath

pub fn from_rooted(root: &Path, candidate: &Path) -> Result<Self>

Creates a new SafePath from a root and candidate path.

This function ensures that the candidate path is within the root path and does not contain any unsafe components like dotdot (..).

Arguments

• root - The root path that the candidate should be within
• candidate - The path to check and make safe

Returns

• Result<Self> - A SafePath if the candidate is valid, or an error otherwise

Errors

Returns an error if the root path is not absolute, if the candidate path escapes the root, or if the candidate path contains unsafe components like dotdot (..).

Panics

Panics when root is not absolute. This mirrors historical semantics and preserves SPEC/BDD expectations for construction invariants in tests.

Example

use switchyard::types::safepath::SafePath;
let td = tempfile::tempdir()?;
let root = td.path();
std::fs::create_dir_all(root.join("usr/bin"))?;
let sp = SafePath::from_rooted(root, &root.join("usr/bin/ls"))?;
assert!(sp.as_path().starts_with(root));

pub fn as_path(&self) -> PathBuf

Returns the full path by joining the root and relative components.

Returns

• PathBuf - The complete path

pub fn rel(&self) -> &Path

Returns a reference to the relative path component.

Returns

• &Path - Reference to the relative path

Trait Implementations

impl Clone for SafePath

fn clone(&self) -> SafePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SafePath

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

Formats the value using the given formatter.

impl PartialEq for SafePath

fn eq(&self, other: &SafePath) -> 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 Eq for SafePath

impl StructuralPartialEq for SafePath