Struct SafePathBuf 

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

A wrapper for PathBuf that prevents path traversal.

Examples

assert!(SafePathBuf::new("../secret.txt".into()).is_err());
assert!(SafePathBuf::new("/home/user/stuff/../secret.txt".into()).is_err());

assert!(SafePathBuf::new("./file.txt".into()).is_ok());
assert!(SafePathBuf::new("/home/user/secret.txt".into()).is_ok());

Implementations

impl SafePathBuf

pub fn new(path: PathBuf) -> Result<Self, &'static str>

Validates the path for directory traversal vulnerabilities and returns a new SafePathBuf instance if it is safe.

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

Returns an object that implements std::fmt::Display for safely printing paths.

See PathBuf for more information.

Trait Implementations

impl AsRef<Path> for SafePathBuf

fn as_ref(&self) -> &Path

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

impl Clone for SafePathBuf

fn clone(&self) -> SafePathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SafePathBuf

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SafePathBuf

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for SafePathBuf

type Err = &'static str

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Serialize for SafePathBuf

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.