Struct seckey::SecKey

pub struct SecKey<T> { /* fields omitted */ }

Secure Key.

The use memsec/malloc protection secret bytes.

More docs see Secure memory · libsodium.

Methods

impl<T> SecKey<T> where T: Sized

fn new(t: T) -> Result<SecKey<T>, T>

use seckey::SecKey;

let k = SecKey::new([1]).unwrap();
assert_eq!([1], *k.read());

unsafe fn from_raw(t: *const T) -> Option<SecKey<T>>

use seckey::SecKey;

let mut v = [1];
let k = unsafe { SecKey::from_raw(&v).unwrap() };
assert_eq!([1], v);
assert_eq!([1], *k.read());

impl<T> SecKey<T>

fn read(&self) -> SecReadGuard<T>

Borrow Read.

use seckey::SecKey;

let secpass = SecKey::new([8u8; 8]).unwrap();
assert_eq!([8u8; 8], *secpass.read());

fn write(&mut self) -> SecWriteGuard<T>

Borrow Write.

let mut wpass = secpass.write();
wpass[0] = 0;
assert_eq!([0, 8, 8, 8, 8, 8, 8, 8], *wpass);

Trait Implementations

impl<T> Default for SecKey<T> where T: Default

fn default() -> Self

Returns the "default value" for a type.

impl<T> Debug for SecKey<T>

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

Formats the value using the given formatter.

impl<T> Pointer for SecKey<T>

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

Formats the value using the given formatter.

impl<T> Drop for SecKey<T>

fn drop(&mut self)

A method called when the value goes out of scope.