[−][src]Struct cryptovec::CryptoVec

pub struct CryptoVec { /* fields omitted */ }

A buffer which zeroes its memory on .clear(), .resize() and reallocations, to avoid copying secrets around.

Implementations

`impl CryptoVec`[src]

`pub fn new() -> CryptoVecⓘNotable traits for CryptoVec impl Write for CryptoVec`[src]

Creates a new CryptoVec.

`pub fn new_zeroed(size: usize) -> CryptoVecⓘNotable traits for CryptoVec impl Write for CryptoVec`[src]

Creates a new CryptoVec with n zeros.

`pub fn with_capacity(capacity: usize) -> CryptoVecⓘNotable traits for CryptoVec impl Write for CryptoVec`[src]

Creates a new CryptoVec with capacity capacity.

`pub fn len(&self) -> usize`[src]

Length of this CryptoVec.

assert_eq!(cryptovec::CryptoVec::new().len(), 0)

`pub fn is_empty(&self) -> bool`[src]

Returns true if and only if this CryptoVec is empty.

assert!(cryptovec::CryptoVec::new().is_empty())

`pub fn resize(&mut self, size: usize)`[src]

Resize this CryptoVec, appending zeros at the end. This may perform at most one reallocation, overwriting the previous version with zeros.

`pub fn clear(&mut self)`[src]

Clear this CryptoVec (retaining the memory).

let mut v = cryptovec::CryptoVec::new();
v.extend(b"blabla");
v.clear();
assert!(v.is_empty())

`pub fn push(&mut self, s: u8)`[src]

Append a new byte at the end of this CryptoVec.

`pub fn push_u32_be(&mut self, s: u32)`[src]

Append a new u32, big endian-encoded, at the end of this CryptoVec.

let mut v = cryptovec::CryptoVec::new();
let n = 43554;
v.push_u32_be(n);
assert_eq!(n, v.read_u32_be(0))

`pub fn read_u32_be(&self, i: usize) -> u32`[src]

Read a big endian-encoded u32 from this CryptoVec, with the first byte at position i.

let mut v = cryptovec::CryptoVec::new();
let n = 99485710;
v.push_u32_be(n);
assert_eq!(n, v.read_u32_be(0))

`pub fn read<R: Read>(&mut self, n_bytes: usize, r: R) -> Result<usize, Error>`[src]

Read n_bytes from r, and append them at the end of this CryptoVec. Returns the number of bytes read (and appended).

`pub fn write_all_from<W: Write>( &self, offset: usize, w: W ) -> Result<usize, Error>`[src]

Write all this CryptoVec to the provided Write. Returns the number of bytes actually written.

let mut v = cryptovec::CryptoVec::new();
v.extend(b"blabla");
let mut s = std::io::stdout();
v.write_all_from(0, &mut s).unwrap();

`pub fn resize_mut(&mut self, n: usize) -> &mut [u8]`[src]

Resize this CryptoVec, returning a mutable borrow to the extra bytes.

let mut v = cryptovec::CryptoVec::new();
v.resize_mut(4).clone_from_slice(b"test");

`pub fn extend(&mut self, s: &[u8])`[src]

Append a slice at the end of this CryptoVec.

let mut v = cryptovec::CryptoVec::new();
v.extend(b"test");

`pub fn from_slice(s: &[u8]) -> CryptoVecⓘNotable traits for CryptoVec impl Write for CryptoVec`[src]

Create a CryptoVec from a slice

CryptoVec::from_slice(b"test");

Trait Implementations

`impl AsMut<[u8]> for CryptoVec`[src]

`fn as_mut(&mut self) -> &mut [u8]`[src]

`impl AsRef<[u8]> for CryptoVec`[src]

`fn as_ref(&self) -> &[u8]`[src]

`impl Clone for CryptoVec`[src]

`fn clone(&self) -> Self`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for CryptoVec`[src]

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

`impl Default for CryptoVec`[src]

`fn default() -> Self`[src]

`impl Deref for CryptoVec`[src]

`type Target = [u8]`

The resulting type after dereferencing.

`fn deref(&self) -> &[u8]`[src]

`impl DerefMut for CryptoVec`[src]

`fn deref_mut(&mut self) -> &mut [u8]`[src]

`impl Drop for CryptoVec`[src]

`fn drop(&mut self)`[src]

`impl From<String> for CryptoVec`[src]

`fn from(e: String) -> Self`[src]