Struct SecretString 

pub struct SecretString { /* private fields */ }

Redacted secret wrapper for runtime and connector configuration.

Implementations

impl SecretString

pub fn new(value: impl Into<String>) -> Self

Create a new secret wrapper from an owned string.

pub fn from_provider( provider_name: impl Into<String>, reference: impl Into<String>, provider: Arc<dyn SecretProvider>, ) -> Self

Resolve a secret from an external provider at connect time.

pub fn from_callback( label: impl Into<String>, callback: impl Fn() -> Result<String> + Send + Sync + 'static, ) -> Self

Resolve a secret through a callback at connect time.

pub fn expose_secret(&self) -> Result<&str>

Return the inline secret value.

Deferred secrets must be resolved with resolve.

pub fn resolve(&self) -> Result<String>

Resolve the secret value for connector internals.

pub fn into_inner(self) -> Result<String>

Consume the wrapper and return the inline secret.

pub fn is_empty(&self) -> Result<bool>

Whether the resolved secret is empty.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretString

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

Formats the value using the given formatter.

impl Default for SecretString

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Eq for SecretString

impl From<&str> for SecretString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecretString

fn eq(&self, other: &Self) -> bool

Compare two SecretString values for equality.

Security

For Inline secrets this comparison exposes the raw secret value to the CPU’s branch predictor and is not constant-time. It is safe for configuration deduplication (the intended use case) but must not be used for authentication token comparison, HMAC verification, or any context where timing oracles are a threat model. Use subtle::ConstantTimeEq (or equivalent) for security-sensitive equality checks.

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 Serialize for SecretString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serializes as the literal string "[REDACTED]".

Secret values are never included in serialized output regardless of variant. Configs serialized to JSON, TOML, or any other format will always see "[REDACTED]" in the password field, making it safe to log config snapshots for diagnostics without leaking credentials.