Struct sodoken::BufWriteSized

source ·

pub struct BufWriteSized<const N: usize>(pub Arc<dyn AsBufWriteSized<N>>);

Expand description

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

Tuple Fields§

§0: Arc<dyn AsBufWriteSized<N>>

Implementations§

source §

impl<const N: usize> BufWriteSized<N>

source

pub fn new_no_lock() -> Self

Consruct a new BufWrite that is NOT mem_locked.

source

pub fn new_mem_locked() -> 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.

source

pub fn deep_clone_no_lock<O>(o: O) -> Self
where O: Into<BufReadSized<N>> + 'static + Send,

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

source

pub fn deep_clone_mem_locked<O>(o: O) -> SodokenResult<Self>
where O: Into<BufReadSized<N>> + 'static + Send,

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

source

pub fn len(&self) -> usize

The length of this buffer.

source

pub fn is_empty(&self) -> bool

Is this buffer empty?

source

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

Obtain read access to the underlying buffer.

source

pub fn read_lock_sized(&self) -> ReadGuardSized<'_, N>

Obtain read access to the underlying buffer.

source

pub fn to_read_unsized(&self) -> BufRead

Convert to an unsized BufRead instance without cloning internal data and without changing memory locking strategy.

source

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

Obtain write access to the underlying buffer.

source

pub fn to_read(&self) -> BufRead

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

source

pub fn write_lock_sized(&self) -> WriteGuardSized<'_, N>

Obtain write access to the underlying buffer.

source

pub fn to_read_sized(&self) -> BufReadSized<N>

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

source

pub fn to_write_unsized(&self) -> BufWrite

Convert to an unsized BufWrite instance without cloning internal data and without changing memory locking strategy.

source

pub fn to_extend(&self) -> BufExtend

Transform this buffer into an extendable type.

source

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.

source

pub fn try_unwrap_sized(self) -> Result<[u8; N], BufReadSized<N>>

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.