redact 0.1.11

A simple library for keeping secrets out of logs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(not(feature = "std"), no_std)]
#![forbid(unsafe_code)]

#[cfg(feature = "std")]
mod error;
#[cfg(feature = "fake")]
mod fake;
mod ops;
#[cfg(feature = "serde")]
pub mod serde;
#[cfg(feature = "zeroize")]
mod zeroize;

#[cfg(feature = "serde")]
pub use crate::serde::expose_secret;

use core::{any::type_name, fmt, str::FromStr};

/// See [module level documentation][crate]
#[derive(Default, Hash, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
#[repr(transparent)]
pub struct Secret<T: ?Sized>(T);

impl<T> Secret<T> {
    /// See [module level documentation][crate]
    #[inline]
    #[must_use = "the secret will be dropped if not used"]
    pub const fn new(secret: T) -> Self {
        Self(secret)
    }
    #[inline]
    #[must_use]
    pub fn from(secret: impl Into<T>) -> Self {
        Self(secret.into())
    }
    #[inline]
    pub fn try_from<U: TryInto<T>>(secret: U) -> Result<Self, Secret<U::Error>> {
        secret.try_into().map(Self).map_err(Secret)
    }
    /// See [module level documentation][crate]
    #[inline]
    #[must_use = "expose_secret does nothing unless used"]
    pub const fn expose_secret(&self) -> &T {
        &self.0
    }
}

impl<T> From<T> for Secret<T> {
    #[inline]
    fn from(secret: T) -> Self {
        Self::new(secret)
    }
}

impl<T> fmt::Debug for Secret<T> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "[REDACTED {}]", type_name::<T>())
    }
}

impl<T: FromStr> FromStr for Secret<T> {
    type Err = Secret<T::Err>;

    #[inline]
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        s.parse().map(Self).map_err(Secret)
    }
}

impl<T> From<Option<Secret<T>>> for Secret<Option<T>> {
    #[inline]
    fn from(secret: Option<Secret<T>>) -> Self {
        Self(secret.map(|Secret(s)| s))
    }
}

impl<T, E> From<Result<Secret<T>, E>> for Secret<Result<T, E>> {
    #[inline]
    fn from(secret: Result<Secret<T>, E>) -> Self {
        Self(secret.map(|Secret(s)| s))
    }
}

impl<T, E> From<Result<T, Secret<E>>> for Secret<Result<T, E>> {
    #[inline]
    fn from(secret: Result<T, Secret<E>>) -> Self {
        Self(secret.map_err(|Secret(s)| s))
    }
}

impl<T, E> From<Result<Secret<T>, Secret<E>>> for Secret<Result<T, E>> {
    #[inline]
    fn from(secret: Result<Secret<T>, Secret<E>>) -> Self {
        Self(secret.map(|Secret(s)| s).map_err(|Secret(s)| s))
    }
}

impl<S: FromIterator<T>, T> FromIterator<Secret<T>> for Secret<S> {
    #[inline]
    fn from_iter<I: IntoIterator<Item = Secret<T>>>(iter: I) -> Self {
        Self(S::from_iter(iter.into_iter().map(|Secret(s)| s)))
    }
}