Struct Username 

#[non_exhaustive]
pub struct Username(/* private fields */);

The authenticated user’s username (RFC 8620 §2 username field).

Typically an email address, and therefore PII under GDPR / CCPA. The wrapper exists to centralise PII handling at the type level:

• Display redacts to "[REDACTED]". println!("{}", username), format!("{username}"), and tracing::info!(user = %username, ...) all hit Display and therefore the redaction. The pre-bd:JMAP-6r7c.63 shape (pub username: String) leaked the raw value through every Display-bearing path.
• Debug redacts to Username("[REDACTED]"). Pre-existing Session::Debug already redacted explicitly; keeping the wrapper’s own redaction makes the field safe to print even outside the Session::Debug path (e.g. if a caller stores the Username in a struct of their own and derives Debug on it).
• Serialize emits the raw value verbatim because the wire format requires it for round-trip. Callers who want to scrub the field before serialising MUST do so explicitly.
• expose_unredacted is the only path to the raw string. The accessor name is deliberately explicit so the intent is visible at the call site in code review.

Construct via Username::new or via deserialize.

Implementations

impl Username

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

Wrap a string as a Username.

pub fn expose_unredacted(&self) -> &str

Return the raw, un-redacted username string.

Do not log this return value. This is the only path to the raw PII; the explicit accessor name surfaces the intent in code review. Use only when the wire format requires the raw value (e.g. constructing an Authorization header that re-uses the username, building an audit log under a separate PII-handling policy).

pub fn into_inner(self) -> String

Consume the wrapper and return the inner String.

Same handling guidance as expose_unredacted — the caller now owns a raw String and must handle PII manually from that point on.

Trait Implementations

impl Clone for Username

fn clone(&self) -> Username

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Username

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Username

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Username

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

Formats the value using the given formatter.

impl Eq for Username

impl Hash for Username

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 PartialEq for Username

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<&str> for Username

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<Username> for &str

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<Username> for str

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<str> for Username

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

Tests for self and other values to be equal, and is used by ==.

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 Username

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Username