synapto-interface 0.1.0-dev.8

Interface definitions for the Synapto 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

use serde::{Deserialize, Serialize};
use std::fmt;

/// A wrapper that redacts its contents in Debug logs and Serialization (UI/API),
/// requiring explicit method calls to access the underlying value.
#[derive(Clone, Default, Deserialize)]
#[serde(transparent)]
pub struct Secret<T>(T);

impl<T> Secret<T> {
    /// Creates a new Secret.
    pub fn new(value: T) -> Self {
        Self(value)
    }

    /// Explicitly exposes the secret by reference.
    #[inline]
    pub fn expose_secret(&self) -> &T {
        &self.0
    }

    /// Consumes the wrapper and returns the raw secret.
    #[inline]
    pub fn expose_owned_secret(self) -> T {
        self.0
    }

    #[inline]
    pub fn into_secret<U>(self) -> Secret<U>
    where
        T: Into<U>,
    {
        Secret(self.0.into())
    }
}

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

impl<T> Serialize for Secret<T> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        // Always serializes as a generic string, regardless of inner type T
        serializer.serialize_str("[REDACTED]")
    }
}