Struct SecBuffer 

pub struct SecBuffer {
    pub inner: BytesMut,
}

A memory-secure wrapper for shipping around Bytes

Fields

inner: BytesMut

Implementations

impl SecBuffer

pub fn empty() -> Self

Creates an unlocked, empty buffer

pub fn with_capacity(cap: usize) -> Self

pub fn into_buffer(self) -> BytesMut

Returns the inner element without dropping the memory

pub fn handle(&mut self) -> SecureBufMutHandle<'_>

For accessing the inner element

pub fn len(&self) -> usize

returns the length of the buffer

pub fn reserve(&mut self, additional: usize)

pub fn is_empty(&self) -> bool

Trait Implementations

impl AsMut<[u8]> for SecBuffer

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for SecBuffer

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SecBuffer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecBuffer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecBuffer

fn deserialize<D>( deserializer: D, ) -> Result<Self, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl From<&[u8]> for SecBuffer

fn from(this: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for SecBuffer

fn from(this: &str) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[u8; N]> for SecBuffer

fn from(this: [u8; N]) -> Self

Converts to this type from the input type.

impl From<BytesMut> for SecBuffer

fn from(inner: BytesMut) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for SecBuffer

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

Converts to this type from the input type.

impl<T: AsRef<[u8]>> PartialEq<T> for SecBuffer

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SecBuffer

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.