Struct KeyId 

pub struct KeyId([u8; 16]);

A key id is a unique identifier for a single key. There is a 1:1 mapping between key ID and key bytes, so something like a user key rotation is replacing the key with ID A with a new key with ID B.

Tuple Fields

0: [u8; 16]

Implementations

impl KeyId

Fixed length identifiers for keys. These are intended to be unique and constant per-key.

Currently these are randomly generated 16 byte identifiers, which is considered safe to randomly generate with vanishingly small collision chance. However, the generation of IDs is an internal concern and may change in the future.

pub fn make() -> Self

Creates a new random key ID randomly, sampled from the crates CSPRNG.

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

Returns the key ID as a slice of bytes.

Trait Implementations

impl Clone for KeyId

fn clone(&self) -> KeyId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for KeyId

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<UT> ConvertError<UT> for KeyId

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for KeyId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyId

Key ids travel on the wire as a lowercase hex encoding of the 16 raw bytes, giving a fixed 32-character string. The server rejects any other encoding.

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for KeyId

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = <String as Lower<UniFfiTag>>::FfiType

The low-level type used for passing values of this type over the FFI.

fn lower(obj: KeyId) -> Self::FfiType

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(v: Self::FfiType) -> Result<KeyId>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: KeyId, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<KeyId>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<&KeyId> for Vec<u8>

fn from(key_id: &KeyId) -> Self

Converts to this type from the input type.

impl From<[u8; 16]> for KeyId

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

Converts to this type from the input type.

impl From<KeyId> for [u8; 16]

fn from(key_id: KeyId) -> Self

Converts to this type from the input type.

impl FromStr for KeyId

Parses the hex encoding produced by Display. Anything that is not exactly 16 bytes worth of hex is rejected.

type Err = CryptoError

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 FromWasmAbi for KeyId

Available on crate feature wasm only.

type Abi = <String as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(abi: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for KeyId

Available on crate feature wasm only.

type Abi = <String as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for KeyId

type FfiType = <KeyId as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for KeyId

type LiftType = KeyId

impl<UT> LiftReturn<UT> for KeyId

type ReturnType = <KeyId as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for KeyId

type FfiType = <KeyId as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for KeyId

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for KeyId

type ReturnType = <KeyId as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for KeyId

Available on crate feature wasm only.

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl PartialEq for KeyId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KeyId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for KeyId

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for KeyId

Available on crate feature wasm only.

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<UT> TypeId<UT> for KeyId

const TYPE_ID_META: MetadataBuffer

impl WasmDescribe for KeyId

Available on crate feature wasm only.

fn describe()

impl Zeroize for KeyId

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 StructuralPartialEq for KeyId