Skip to main content

Unredacted

Struct Unredacted 

Source
pub struct Unredacted<T>(pub T);
Expand description

Wrapper that opts a value in to formatting or serialization that would otherwise expose private-key bytes.

Wrap an ed25519::PrivateKey in Unredacted for any of:

  • Display / to_string / write_string — renders the encoded strkey string (S…).
  • Debug — prints the raw 32-byte seed as hex (PrivateKey(<hex>)). Bare PrivateKey’s Debug redacts.
  • serde::Serialize (under the serde feature) — serializes as the strkey string form.
  • Decoded<Unredacted<&PrivateKey>> (under the serde-decoded feature) — serializes the raw seed as hex inside a JSON object.

§Zeroize

Display, to_string, and serde::Serialize materialize the encoded bytes into a non-zeroizing intermediate (the returned String, the formatter, or the serializer’s internal buffer). For the strongest guarantees, use Unredacted::write_string to write directly into a caller-provided Zeroizing buffer.

Tuple Fields§

§0: T

Implementations§

Source§

impl Unredacted<&PrivateKey>

Source

pub fn to_string(&self) -> String<{ PrivateKey::ENCODED_LEN }>

Encodes this private key to its strkey string form.

§Zeroize

The intermediate scratch buffers used during encoding are zeroed on drop, but the returned String itself is plain — its bytes are not zeroed when the value is dropped. Use write_string for zeroizing.

Source

pub fn write_string( &self, out: &mut Zeroizing<String<{ PrivateKey::ENCODED_LEN }>>, )

Encodes this private key to its strkey string form, writing the result into the caller-provided buffer.

§Zeroize

The intermediate scratch buffers used during encoding are wrapped in Zeroizing and zeroed on drop, and the encoded bytes are written directly into out rather than returned by value, so no copy is left on this method’s stack frame.

Trait Implementations§

Source§

impl<T: Clone> Clone for Unredacted<T>

Source§

fn clone(&self) -> Unredacted<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Unredacted<T>

Source§

impl Debug for Unredacted<&PrivateKey>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Debug for Unredacted<PrivateKey>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Unredacted<&PrivateKey>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Unredacted<PrivateKey>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Eq> Eq for Unredacted<T>

Source§

impl<T: Hash> Hash for Unredacted<T>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: Ord> Ord for Unredacted<T>

Source§

fn cmp(&self, other: &Unredacted<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for Unredacted<T>

Source§

fn eq(&self, other: &Unredacted<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd> PartialOrd for Unredacted<T>

Source§

fn partial_cmp(&self, other: &Unredacted<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: PartialEq> StructuralPartialEq for Unredacted<T>

Auto Trait Implementations§

§

impl<T> Freeze for Unredacted<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Unredacted<T>
where T: RefUnwindSafe,

§

impl<T> Send for Unredacted<T>
where T: Send,

§

impl<T> Sync for Unredacted<T>
where T: Sync,

§

impl<T> Unpin for Unredacted<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Unredacted<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Unredacted<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.