Struct sodoken::buffer::BufWriteMemLockedSized

pub struct BufWriteMemLockedSized<const N: usize>(_);

This writable buffer type is mem_locked. Use this for passwords / private keys, etc, but NOT everything, locked memory is a finite resource.

Implementations

impl<const N: usize> BufWriteMemLockedSized<N>

pub fn new() -> SodokenResult<Self>

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

Trait Implementations

impl<const N: usize> AsBufExtend for BufWriteMemLockedSized<N>

fn extend_lock(&self) -> ExtendGuard<'_>

Obtain access to extend the underlying buffer. Warning: Depending on the underlying data type, each new ExtendGuard could be a new cursor… i.e. pulling a new extend lock could overwrite previous data.

impl<const N: usize> AsBufRead for BufWriteMemLockedSized<N>

fn len(&self) -> usize

The length of this buffer.

fn is_empty(&self) -> bool

Is this buffer empty?

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

Obtain read access to the underlying buffer.

fn try_unwrap(self: Arc<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.

impl<const N: usize> AsBufReadSized<N> for BufWriteMemLockedSized<N>

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

Obtain read access to the underlying buffer.

fn into_read_unsized(self: Arc<Self>) -> BufRead

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

fn try_unwrap_sized(self: Arc<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.

impl<const N: usize> AsBufWrite for BufWriteMemLockedSized<N>

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

Obtain write access to the underlying buffer.

fn into_read(self: Arc<Self>) -> BufRead

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

fn into_extend(self: Arc<Self>) -> BufExtend

Transform this buffer into an extendable type.

impl<const N: usize> AsBufWriteSized<N> for BufWriteMemLockedSized<N>

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

Obtain write access to the underlying buffer.

fn into_read_sized(self: Arc<Self>) -> BufReadSized<N>

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

fn into_write_unsized(self: Arc<Self>) -> BufWrite

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

impl<const N: usize> Debug for BufWriteMemLockedSized<N>

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

Formats the value using the given formatter.