Struct SafeFilename 

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

A validated filename (no path separators, shell metacharacters, or traversal).

Examples

use secure_boundary::safe_types::SafeFilename;

let name = SafeFilename::try_from("report.pdf").unwrap();
assert_eq!(name.as_inner(), "report.pdf");

assert!(SafeFilename::try_from("../evil").is_err());

Implementations

impl SafeFilename

pub fn as_inner(&self) -> &str

Returns a reference to the inner filename string.

pub fn into_inner(self) -> String

Consumes the wrapper and returns the inner filename string.

Trait Implementations

impl Clone for SafeFilename

fn clone(&self) -> SafeFilename

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SafeFilename

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SafeFilename

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

Deserialize this value from the given Serde deserializer.

impl Display for SafeFilename

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

Formats the value using the given formatter.

impl Hash for SafeFilename

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 SafeFilename

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

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 SafeFilename

impl StructuralPartialEq for SafeFilename