Struct SafePath 

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

A validated relative file-system path.

Rejects directory traversal (../, ..\), absolute paths, null bytes, and percent-encoded traversal sequences.

Examples

use secure_boundary::safe_types::SafePath;

let path = SafePath::try_from("uploads/photo.jpg").unwrap();
assert_eq!(path.as_inner(), "uploads/photo.jpg");

// Traversal attempts are rejected.
assert!(SafePath::try_from("../../etc/passwd").is_err());

Implementations

impl SafePath

pub fn as_inner(&self) -> &str

Returns a reference to the inner path string.

pub fn into_inner(self) -> String

Consumes the wrapper and returns the inner path string.

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<'de> Deserialize<'de> for SafePath

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for SafePath

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

Formats the value using the given formatter.

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

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 TryFrom<&str> for SafePath

type Error = BoundaryRejection

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SafePath

impl StructuralPartialEq for SafePath