Struct sodoken::BufWrite

pub struct BufWrite(pub Arc<dyn AsBufWrite>);

A concrete writable buffer type that may or may not be mem_locked.

Tuple Fields

0: Arc<dyn AsBufWrite>

Implementations

impl BufWrite

pub fn new_no_lock(size: usize) -> Self

Construct a new BufWrite that is NOT mem_locked.

pub fn new_mem_locked(size: usize) -> SodokenResult<Self>

Construct a new BufWrite that IS mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.

pub fn deep_clone_no_lock<O>(o: O) -> Self

where O: Into<BufRead> + 'static + Send,

Deep clone the data referred to by another buffer object, into a new non-memory-locked BufWrite instance.

pub fn deep_clone_mem_locked<O>(o: O) -> SodokenResult<Self>

where O: Into<BufRead> + 'static + Send,

Deep clone the data referred to by another buffer object, into a new MEMORY LOCKED BufWrite instance.

pub fn len(&self) -> usize

The length of this buffer.

pub fn is_empty(&self) -> bool

Is this buffer empty?

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.

pub fn to_read(&self) -> BufRead

Downgrade this to a read-only reference without cloning internal data and without changing memory locking strategy.

pub fn to_extend(&self) -> BufExtend

Transform this buffer into an extendable type.

pub fn try_unwrap(self) -> Result<Box<[u8]>, BufRead>

Attempt to extract the inner contents of this buf without cloning. If this memory is locked or there are clones of this reference, the unwrap will fail, returning a BufRead instance.

Trait Implementations

impl Clone for BufWrite

fn clone(&self) -> BufWrite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufWrite

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

Formats the value using the given formatter.

impl From<Box<[u8]>> for BufWrite

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

Converts to this type from the input type.

impl From<BufWrite> for BufExtend

fn from(b: BufWrite) -> Self

Converts to this type from the input type.

impl From<BufWrite> for BufRead

fn from(b: BufWrite) -> Self

Converts to this type from the input type.

impl<const S: usize> From<BufWriteSized<S>> for BufWrite

fn from(b: BufWriteSized<S>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for BufWrite

fn from(b: Vec<u8>) -> Self

Converts to this type from the input type.