Struct Sanitized 

pub struct Sanitized<T: MarkerType> { /* private fields */ }

A value that has passed all sanitization rules for marker type T.

This type cannot be constructed directly — it is only produced by Sanitizer::sanitize. This guarantees at the type level that the inner string has been validated.

Example

use shell_sanitize::{Sanitizer, Sanitized, ShellArg};

fn run_command(arg: &Sanitized<ShellArg>) {
    // Safe to use in command construction
    let _ = arg.as_str();
}

Implementations

impl<T: MarkerType> Sanitized<T>

pub fn as_str(&self) -> &str

Access the sanitized string.

pub fn into_inner(self) -> String

Consume and return the inner string.

Trait Implementations

impl<T: MarkerType> AsRef<str> for Sanitized<T>

fn as_ref(&self) -> &str

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

impl<T: Clone + MarkerType> Clone for Sanitized<T>

fn clone(&self) -> Sanitized<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: MarkerType> Debug for Sanitized<T>

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

Formats the value using the given formatter.

impl<T: MarkerType> Display for Sanitized<T>

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

Formats the value using the given formatter.

impl<T: Hash + MarkerType> Hash for Sanitized<T>

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<T: PartialEq + MarkerType> PartialEq for Sanitized<T>

fn eq(&self, other: &Sanitized<T>) -> 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<T: Eq + MarkerType> Eq for Sanitized<T>

impl<T: MarkerType> StructuralPartialEq for Sanitized<T>