Struct SecretVLByteVec 

pub struct SecretVLByteVec(/* private fields */);

Available on crate feature std only.

A wrapper struct around VLByteVec that implements ZeroizeOnDrop. It behaves just like VLByteVec, except that it doesn’t allow conversion into a Vec<u8>.

Like VLByteVec, SecretVLByteVec produces a different serde format than the deprecated SecretVLBytes, but its Deserialize impl is backwards-compatible: it accepts both its own native encoding and the legacy SecretVLBytes encoding (a struct with a vec field containing a sequence of u8) for self-describing serde formats.

Implementations

impl SecretVLByteVec

pub fn new(vec: Vec<u8>) -> Self

Generate a new variable-length byte vector that implements ZeroizeOnDrop.

impl SecretVLByteVec

pub fn as_slice(&self) -> &[u8]

Get a reference to the vlbytes’s vec.

pub fn push(&mut self, value: u8)

Add an element to this.

pub fn pop(&mut self) -> Option<u8>

Remove the last element.

Trait Implementations

impl AsRef<[u8]> for SecretVLByteVec

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

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

impl Clone for SecretVLByteVec

fn clone(&self) -> SecretVLByteVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretVLByteVec

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

Formats the value using the given formatter.

impl Deserialize for SecretVLByteVec

fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>

where Self: Sized,

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl<'de> Deserialize<'de> for SecretVLByteVec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DeserializeBytes for SecretVLByteVec

fn tls_deserialize_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

where Self: Sized,

This function deserializes the bytes from the provided a &[u8] and returns the populated struct, as well as the remaining slice.

fn tls_deserialize_exact_bytes(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl Drop for SecretVLByteVec

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for SecretVLByteVec

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

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

Converts to this type from the input type.

impl From<&[u8]> for SecretVLByteVec

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

Converts to this type from the input type.

impl From<Vec<u8>> for SecretVLByteVec

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

Converts to this type from the input type.

impl Hash for SecretVLByteVec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SecretVLByteVec

fn cmp(&self, other: &SecretVLByteVec) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SecretVLByteVec

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SecretVLByteVec

fn partial_cmp(&self, other: &SecretVLByteVec) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SecretVLByteVec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for SecretVLByteVec

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl Size for SecretVLByteVec

fn tls_serialized_len(&self) -> usize

impl StructuralPartialEq for SecretVLByteVec

impl Zeroize for SecretVLByteVec

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl ZeroizeOnDrop for SecretVLByteVec