Struct VLByteVec 

pub struct VLByteVec { /* private fields */ }

Available on 32-bit or 64-bit only.

Variable-length encoded byte vector.

Functionally equivalent to VLBytes, but its serde representation uses serde_bytes to serialize the contained byte vector as a byte blob via #[serde(transparent)]. This produces a much more compact encoding for serde formats that distinguish byte arrays from sequences of u8 (e.g. CBOR, MessagePack, bincode).

While the serde format produced by VLByteVec is not compatible with the format produced by VLBytes, VLByteVec’s custom Deserialize impl is backwards-compatible: it accepts both its own native bytes encoding and the legacy VLBytes encoding (a struct with a vec field containing a sequence of u8). This lets callers transparently migrate persisted VLBytes data to VLByteVec for self-describing formats such as CBOR, JSON or MessagePack.

Implementations

impl VLByteVec

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

Generate a new variable-length byte vector.

impl VLByteVec

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 VLByteVec

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

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

impl Clone for VLByteVec

fn clone(&self) -> VLByteVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VLByteVec

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

Formats the value using the given formatter.

impl Deserialize for VLByteVec

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

where R: Read,

Available on crate feature std only.

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,

Available on crate feature std only.

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

impl<'de> Deserialize<'de> for VLByteVec

fn deserialize<__D>( __deserializer: __D, ) -> Result<VLByteVec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DeserializeBytes for VLByteVec

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

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 Eq for VLByteVec

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

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

Converts to this type from the input type.

impl From<&[u8]> for VLByteVec

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

Converts to this type from the input type.

impl From<VLByteVec> for Vec<u8>

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

Converts to this type from the input type.

impl From<Vec<u8>> for VLByteVec

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

Converts to this type from the input type.

impl Hash for VLByteVec

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

where __H: Hasher,

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 VLByteVec

fn cmp(&self, other: &VLByteVec) -> 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 VLByteVec

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VLByteVec

fn partial_cmp(&self, other: &VLByteVec) -> 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 VLByteVec

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

where W: Write,

Available on crate feature std only.

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>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Serialize for &VLByteVec

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

where W: Write,

Available on crate feature std only.

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>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Serialize for VLByteVec

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.

impl Size for VLByteVec

fn tls_serialized_len(&self) -> usize

impl Size for &VLByteVec

fn tls_serialized_len(&self) -> usize

impl StructuralPartialEq for VLByteVec

impl Zeroize for VLByteVec

Available on crate feature std only.

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.