Struct RedactedText 

pub struct RedactedText<K: RedactionKind>(/* private fields */);

A value that has already been redacted (via K::redact) for safe inclusion in error or log output — the shared implementation behind RedactedUrl and RedactedName (issue #1216).

Eagerly redacted at construction: Self::new applies K::redact immediately and retains only the resulting text, so the raw value passed in is never stored, not even transiently. The only public read surface — Display, AsRef<str>, a Debug impl that forwards to the redacted text, and Self::into_inner (which hands back that same already-redacted text by value) — is therefore always safe to log: there is no expose()-style escape hatch, because nothing raw remains to expose.

PartialEq/Eq/Hash compare the redacted text, not the original input — see RedactedUrl’s own doc for why this is intentional and what it means for using either alias as a cache key.

Carries no bound on K itself in its own definition — Clone, Debug, PartialEq, Eq, Hash, and Display are all hand-written (not derived) so that none of them require K: Clone/K: Hash/etc., and PhantomData<fn() -> K> (rather than PhantomData<K>) keeps Send/Sync unconditional regardless of K — mirrors crate::net_policy::ValidatedRegistryUrl<K>’s identical shape for the identical reason.

Examples

use deps_core::redact::{RedactedName, RedactedUrl};

let redacted = RedactedUrl::new("https://user:hunter2@registry.example/simple");
assert_eq!(redacted.to_string(), "https://***@registry.example/simple");

let redacted = RedactedName::new("com.google.guava:guava");
assert_eq!(redacted.to_string(), "com.google.guava:guava");

Implementations

impl<K: RedactionKind> RedactedText<K>

pub fn new(raw: &str) -> Self

Redacts raw immediately via K::redact, retaining only the resulting text.

pub fn into_inner(self) -> String

Takes ownership of the redacted text without allocating a second copy — unlike Display/AsRef<str>, which only ever hand back a borrow and so require the caller to clone if it needs an owned String.

Trait Implementations

impl<K: RedactionKind> AsRef<str> for RedactedText<K>

fn as_ref(&self) -> &str

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

impl<K: RedactionKind> Clone for RedactedText<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: RedactionKind> Debug for RedactedText<K>

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

Forwards to the redacted text’s own Debug (a quoted string), not a struct-wrapper rendering — so a RedactedText embedded in a hand-written Debug impl (see deps_core::error::DepsError) reads identically to the plain String field it replaces.

impl<K: RedactionKind> Display for RedactedText<K>

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

Formats the value using the given formatter.

impl<K: RedactionKind> Eq for RedactedText<K>

impl<K: RedactionKind> From<&str> for RedactedText<K>

fn from(raw: &str) -> Self

Converts to this type from the input type.

impl<K: RedactionKind> From<String> for RedactedText<K>

fn from(raw: String) -> Self

Converts to this type from the input type.

impl<K: RedactionKind> Hash for RedactedText<K>

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<K: RedactionKind> PartialEq for RedactedText<K>

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<K: RedactionKind> PartialEq<&str> for RedactedText<K>

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

Warning

Same redacted-text comparison as PartialEq<str> above — other is compared against the redacted text, not treated as raw input.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<K: RedactionKind> PartialEq<str> for RedactedText<K>

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

Warning

Compares against the redacted text, not other as raw input — e.g. RedactedUrl::new(u) == "https://h/p?token=a" is false by construction, since the left side has already dropped the query string.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.