Trait PathExt 

pub trait PathExt {
    // Required methods
    fn is_clean(&self) -> bool;
    fn is_dirty(&self) -> bool;
    fn has_clean_file_name(&self) -> bool;
    fn has_dirty_file_name(&self) -> bool;
}

Extension trait for std::path::Path.

Required Methods

fn is_clean(&self) -> bool

Returns true if the path does not contain banned characters.

Example

use ntfsanitise::PathExt;
use std::path::PathBuf;

assert!(PathBuf::from("/a/clean/path").is_clean());

fn is_dirty(&self) -> bool

Returns true if the path contains banned characters.

Example

use ntfsanitise::PathExt;
use std::path::PathBuf;

assert!(PathBuf::from("/a/dirty?/p<a>th").is_dirty())

fn has_clean_file_name(&self) -> bool

Returns true if the path’s file name does not contain banned characters, or if the path has no file name.

Example

use ntfsanitise::PathExt;
use std::path::PathBuf;

assert!(PathBuf::from("/my/clean_file.name").has_clean_file_name());
assert!(PathBuf::from("/no/file/name/").has_clean_file_name());
assert!(PathBuf::from("/dirty<path>/with/clean_file.name").has_clean_file_name());

fn has_dirty_file_name(&self) -> bool

Returns true if the path’s file name contains banned characters.

Example

use ntfsanitise::PathExt;
use std::path::PathBuf;

assert!(PathBuf::from("/my/dirty<file>.name").has_dirty_file_name());

Implementations on Foreign Types

impl PathExt for Path

fn is_clean(&self) -> bool

fn is_dirty(&self) -> bool

fn has_clean_file_name(&self) -> bool

fn has_dirty_file_name(&self) -> bool

Implementors