Skip to main content

CryptoId

Enum CryptoId 

Source
#[non_exhaustive]
#[repr(u8)]
pub enum CryptoId { None = 0, ChaCha20Poly1305 = 1, Aes256Gcm = 2, }
Expand description

Names the AEAD cipher an entry’s payload was sealed with, if any.

Stored in the high nibble of an entry’s first byte. Any id other than None also means the header carries a 12-byte nonce and a 16-byte authentication tag between the length varint and the payload; both built-in ciphers share that shape.

#[non_exhaustive]: this list has already grown from two variants to three, so match it with a wildcard arm that reports Error::UnknownCrypto rather than one that treats an unrecognized cipher as no cipher at all.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

None = 0

The payload is not encrypted, and the header carries no nonce or tag.

§

ChaCha20Poly1305 = 1

ChaCha20-Poly1305 (RFC 8439), the default cipher.

§

Aes256Gcm = 2

AES-256-GCM, available where hardware acceleration makes it the faster choice.

Implementations§

Source§

impl CryptoId

Source

pub fn as_u8(self) -> u8

The byte written to the high nibble of an entry’s tag byte.

Source

pub fn from_u8(v: u8) -> Result<CryptoId>

Reads a crypto id back out of an entry’s tag byte.

§Errors

Returns Error::UnknownCrypto if v is not an assigned id. Entry bytes are untrusted input, so this is an ordinary runtime outcome rather than a sign of a bug.

Trait Implementations§

Source§

impl Clone for CryptoId

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CryptoId

Source§

impl Debug for CryptoId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CryptoId

Source§

impl PartialEq for CryptoId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CryptoId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.