synwire-core 0.1.0

Core traits and types for the Synwire AI framework
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Secret value type backed by the secrecy crate.

use secrecy::{ExposeSecret, SecretString};
use serde::{Deserialize, Serialize};
use std::fmt;

/// A secret value with memory zeroisation on drop.
///
/// Debug and Display both render as `***`. Serialization produces `null`.
#[derive(Clone)]
pub struct SecretValue {
    inner: SecretString,
}

impl SecretValue {
    /// Creates a new secret value.
    pub fn new(value: impl Into<String>) -> Self {
        Self {
            inner: SecretString::from(value.into()),
        }
    }

    /// Exposes the secret value for explicit access.
    pub fn expose(&self) -> &str {
        self.inner.expose_secret()
    }
}

impl fmt::Debug for SecretValue {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "SecretValue(***)")
    }
}

impl fmt::Display for SecretValue {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "***")
    }
}

impl Serialize for SecretValue {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_none()
    }
}

impl<'de> Deserialize<'de> for SecretValue {
    fn deserialize<D>(_deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        // SecretValue deserializes from null as an empty secret
        Ok(Self::new(""))
    }
}

impl PartialEq for SecretValue {
    fn eq(&self, other: &Self) -> bool {
        self.expose() == other.expose()
    }
}

impl Eq for SecretValue {}

impl std::hash::Hash for SecretValue {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.expose().hash(state);
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;

    #[test]
    fn test_secret_debug_redaction() {
        let secret = SecretValue::new("my-api-key");
        let debug = format!("{secret:?}");
        assert!(!debug.contains("my-api-key"));
        assert!(debug.contains("***"));
    }

    #[test]
    fn test_secret_display_redaction() {
        let secret = SecretValue::new("my-api-key");
        let display = format!("{secret}");
        assert_eq!(display, "***");
    }

    #[test]
    fn test_secret_expose() {
        let secret = SecretValue::new("my-api-key");
        assert_eq!(secret.expose(), "my-api-key");
    }

    #[test]
    fn test_secret_serialize_as_null() {
        let secret = SecretValue::new("my-api-key");
        let json = serde_json::to_string(&secret).unwrap();
        assert_eq!(json, "null");
    }

    #[test]
    fn test_secret_equality() {
        let a = SecretValue::new("key");
        let b = SecretValue::new("key");
        let c = SecretValue::new("other");
        assert_eq!(a, b);
        assert_ne!(a, c);
    }

    #[test]
    fn test_secret_clone() {
        let secret = SecretValue::new("key");
        let cloned = secret.clone();
        assert_eq!(secret.expose(), cloned.expose());
    }
}