Struct SafePath 

pub struct SafePath { /* private fields */ }

A validated path that prevents path traversal attacks

This newtype wrapper around PathBuf ensures that all paths are validated on construction and cannot be modified to violate safety constraints.

Implementations

impl SafePath

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>

Create a new SafePath from a string-like type

Validation Rules

• No parent directory references (..)
• Must be relative or within allowed root (if absolute)
• Maximum depth of 20 levels
• Path components must not be empty or contain only whitespace

Examples

use ggen_utils::safe_path::SafePath;

// Valid paths
assert!(SafePath::new("src/generated").is_ok());
assert!(SafePath::new("./output").is_ok());
assert!(SafePath::new("test").is_ok());

// Invalid paths
assert!(SafePath::new("../etc").is_err());
assert!(SafePath::new("src/../../../etc").is_err());
assert!(SafePath::new("").is_err());

pub fn join<P: AsRef<Path>>(&self, path: P) -> Result<Self>

Join this path with another path component

The joined path is validated to ensure safety constraints are maintained.

Examples

use ggen_utils::safe_path::SafePath;

let base = SafePath::new("src").unwrap();
let joined = base.join("generated").unwrap();
assert_eq!(joined.as_path().to_str().unwrap(), "src/generated");

// Cannot join with parent references
assert!(base.join("../etc").is_err());

pub fn as_path(&self) -> &Path

Get a reference to the inner path

Examples

use ggen_utils::safe_path::SafePath;

let safe = SafePath::new("src/generated").unwrap();
assert_eq!(safe.as_path().to_str().unwrap(), "src/generated");

pub fn into_path_buf(self) -> PathBuf

Convert into the inner PathBuf

Examples

use ggen_utils::safe_path::SafePath;

let safe = SafePath::new("src/generated").unwrap();
let path_buf = safe.into_path_buf();
assert_eq!(path_buf.to_str().unwrap(), "src/generated");

pub fn as_path_buf(&self) -> PathBuf

Get the PathBuf (clone)

Examples

use ggen_utils::safe_path::SafePath;

let safe = SafePath::new("src/generated").unwrap();
let path_buf = safe.as_path_buf();
assert_eq!(path_buf.to_str().unwrap(), "src/generated");

pub fn new_absolute<P: AsRef<Path>>(path: P) -> Result<Self>

Create a SafePath allowing absolute paths (for system paths like config files)

Examples

use ggen_utils::safe_path::SafePath;

let safe = SafePath::new_absolute("/tmp/config.toml").unwrap();
assert!(safe.as_path().is_absolute());

pub fn current_dir() -> Result<Self>

Get current working directory as SafePath

Examples

use ggen_utils::safe_path::SafePath;

let cwd = SafePath::current_dir().unwrap();
assert!(cwd.as_path().is_absolute());

pub fn parent(&self) -> Result<Self>

Get the parent directory

Examples

use ggen_utils::safe_path::SafePath;

let path = SafePath::new("src/generated").unwrap();
let parent = path.parent().unwrap();
assert_eq!(parent.as_path().to_str().unwrap(), "src");

pub fn exists(&self) -> bool

Check if path exists on filesystem

Examples

use ggen_utils::safe_path::SafePath;

let cwd = SafePath::current_dir().unwrap();
assert!(cwd.exists());

Trait Implementations

impl AsRef<Path> for SafePath

fn as_ref(&self) -> &Path

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

impl AsRef<PathBuf> for SafePath

fn as_ref(&self) -> &PathBuf

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

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 Display for SafePath

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

Formats the value using the given formatter.

impl Eq for SafePath

impl Hash for SafePath

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 PartialEq for SafePath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SafePath

impl TryFrom<&Path> for SafePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Path) -> Result<Self>

Performs the conversion.

impl TryFrom<&String> for SafePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for SafePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<PathBuf> for SafePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for SafePath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.