Skip to main content

SecretBuffer

Struct SecretBuffer 

Source
pub struct SecretBuffer<'a> { /* private fields */ }
Expand description

Caller-owned byte buffer that is volatile-cleared when dropped.

The full borrowed slice is cleared on success, error, or early return. This does not clear the source value or copies made by transports, operating systems, crash handlers, or remote services.

Implementations§

Source§

impl<'a> SecretBuffer<'a>

Source

pub const fn new(bytes: &'a mut [u8]) -> Self

Borrows a mutable byte slice until the guard is dropped.

Source

pub fn as_mut_slice(&mut self) -> &mut [u8]

Returns the guarded bytes for request construction.

Source

pub fn as_slice(&self) -> &[u8]

Returns the guarded bytes for transport.

Trait Implementations§

Source§

impl Debug for SecretBuffer<'_>

Source§

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

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

impl Drop for SecretBuffer<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for SecretBuffer<'a>

§

impl<'a> Freeze for SecretBuffer<'a>

§

impl<'a> RefUnwindSafe for SecretBuffer<'a>

§

impl<'a> Send for SecretBuffer<'a>

§

impl<'a> Sync for SecretBuffer<'a>

§

impl<'a> Unpin for SecretBuffer<'a>

§

impl<'a> UnsafeUnpin for SecretBuffer<'a>

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> 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.