Struct chacha20stream::key::Key

#[repr(transparent)]pub struct Key(_);

A 32 byte key for the chacha20_poly1305 cipher

Generation

You can generate a random key with Key::new(). To create a key structure from bytes, you can use Key::from_bytes() if the size of the buffer is exact, or you can write to an empty Key as it implements Default.

let mut key = Key::default();
key.as_mut().copy_from_slice(&key_bytes[..KEY_SIZE]);

You can also generate a random key/IV pair with chacha20stream::keygen().

Encoding

This type implements std::fmt::Display, which prints the key as a base64 string. Additionally, it implements std::str::FromStr, which decodes a base64 string into a Key instance. If the input base64 string data decoded is shorter than KEY_SIZE, the rest of the key instance is padded with 0s. If it is longer, the rest is ignored.

The key can also be lazily formatted as a hex string, with the method to_hex_string().

let key = Key::new();
let key_encoded = key.to_string();

println!("Key base64: {}", key_encoded);
println!("Key hex: {}", key.to_hex_string());

assert_eq!(key_encoded.parse::<Key>().unwrap(), key);

Implementations

impl Key

pub fn from_bytes(k: [u8; 32]) -> Self

Construct a Key from an exact length (32 bytes) buffer.

pub fn new() -> Self

Create a new random 32 byte chacha20_poly1305 Key.

pub fn to_hex_string(&self) -> impl Display + '_

Format this key as a hex string

Returns an opaque type that lazily formats the key into a hex string when written.

Example

fn print_key_info(key: &Key) {
  println!("Key base64: {}", key);
  println!("Key hex: {}", key.to_hex_string());
}

Formatting to String

let key_hex_string = key.to_hex_string().to_string();

Trait Implementations

impl AsMut<[u8]> for Key

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

Performs the conversion.

impl AsRef<[u8]> for Key

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

Performs the conversion.

impl AsRef<Key> for Key

fn as_ref(&self) -> &Key

Performs the conversion.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl From<[u8; 32]> for Key

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

Performs the conversion.

impl FromStr for Key

type Err = DecodeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Key

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Key> for Key

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

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

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

This method tests for !=.

impl StructuralEq for Key

impl StructuralPartialEq for Key