Struct jsonwebkey::ByteVec

pub struct ByteVec(pub Vec<u8>);

A zeroizing-on-drop container for a Vec<u8> that deserializes from base64.

Methods from Deref<Target = Vec<u8>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

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

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl AsRef<Vec<u8>> for ByteVec

fn as_ref(&self) -> &Vec<u8>

Performs the conversion.

impl Clone for ByteVec

fn clone(&self) -> ByteVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteVec

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

Formats the value using the given formatter.

impl Deref for ByteVec

type Target = Vec<u8>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ByteVec

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

Deserialize this value from the given Serde deserializer.

impl Drop for ByteVec

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for ByteVec

impl From<Vec<u8>> for ByteVec

fn from(original: Vec<u8>) -> ByteVec

Performs the conversion.

impl PartialEq<ByteVec> for ByteVec

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for ByteVec

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ByteVec

impl StructuralPartialEq for ByteVec

impl Zeroize for ByteVec

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.