Struct SecretBytes 

pub struct SecretBytes { /* private fields */ }

Arbitrary secret bytes whose backing bytes are overwritten when dropped.

This type intentionally does not implement Clone, Debug, Display, or serde traits. The standard-library-only overwrite is best-effort: Rust does not promise that an optimizer, allocator, operating system, crash dump, or earlier copy cannot retain the bytes.

use rustferry_remote::SecretBytes;
let private_key = SecretBytes::new(b"private-key-value".to_vec());
let _copy = private_key.clone();

Implementations

impl SecretBytes

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

Store secret bytes, taking ownership when the input is an owned vector.

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

Expose the bytes to the narrow operation that needs them.

pub fn len(&self) -> usize

Return the secret length without exposing its contents.

pub fn is_empty(&self) -> bool

Return whether the secret is empty.

pub fn clear(&mut self)

Overwrite the currently held bytes.

Trait Implementations

impl Drop for SecretBytes

fn drop(&mut self)

Executes the destructor for this type.

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.