Struct sodoken::Buffer

pub struct Buffer(pub Arc<dyn AsBuffer + 'static>);

Concrete newtype to abstract away dealing with the dynamic buffer type.

Implementations

impl Buffer

pub fn new(size: usize) -> Buffer

Create a new buffer instance using unlocked memory. No protection will be added, you should consider buffer_new_memlocked for storing private keys and data.

pub fn new_memlocked(size: usize) -> SodokenResult<Buffer>

Create a new buffer instance using locked memory. This is a finite resource, so don't go too crazy. But it is worth doing for things like private keys so they don't get swapped to disk in plaintext.

pub fn deep_clone(&self) -> SodokenResult<Buffer>

Deep clone the actual bytes of this buffer. The type (memlocked or not) will be retained. Not to be confused with "clone" on the Buffer struct, which just bumps a refcount.

pub fn read_lock(&self) -> ReadGuard<'_>

Obtain read access to the underlying buffer.

pub fn write_lock(&self) -> WriteGuard<'_>

Obtain write access to the underlying buffer.

Trait Implementations

impl AsBuffer for Buffer

pub fn deep_clone(&self) -> SodokenResult<Buffer>

Deep clone the actual bytes of this buffer. The type (memlocked or not) will be retained. Not to be confused with "clone" on the Buffer struct, which just bumps a refcount.

pub fn read_lock(&self) -> ReadGuard<'_>

Obtain read access to the underlying buffer.

pub fn write_lock(&self) -> WriteGuard<'_>

Obtain write access to the underlying buffer.

impl Clone for Buffer

pub fn clone(&self) -> Buffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl From<Box<[u8], Global>> for Buffer

pub fn from(o: Box<[u8]>) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Buffer

pub fn from(o: Vec<u8>) -> Self

Performs the conversion.