Struct SecretKey 

pub struct SecretKey { /* private fields */ }

A signing secret key (Ed25519 under VLD0, ML-DSA at VLD1). KEM decryption uses DecapsulationKey. A value tagged with the CryptoKind of the cryptosystem it belongs to.

Ordering compares the kind first (by cryptosystem preference) then the value. Parses and displays as kind:value; a bare value with no kind: prefix decodes against the best available kind.

Implementations

impl SecretKey

pub fn new(kind: CryptoKind, value: BareSecretKey) -> Self

Pairs a value with the CryptoKind it belongs to.

pub fn ref_value(&self) -> &BareSecretKey

Borrows the untagged value.

pub fn into_value(self) -> BareSecretKey

Consumes the wrapper and returns the untagged value.

impl SecretKey

pub fn kind(&self) -> CryptoKind

The cryptosystem this value belongs to.

pub fn value(&self) -> BareSecretKey

A clone of the untagged value.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl Eq for SecretKey

impl From<&SecretKey> for Vec<u8>

fn from(v: &SecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for SecretKeyGroup

fn from(x: SecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for Vec<u8>

fn from(v: SecretKey) -> Self

Converts to this type from the input type.

impl FromStr for SecretKey

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

Errors with VeilidAPIError::Generic if the value part is not valid base64url-nopad.

type Err = VeilidAPIError

The associated error which can be returned from parsing.

impl GetSize for SecretKey

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for SecretKey

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

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 SecretKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SecretKey

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretKey

impl ToVeilidAPIErrorArgument for SecretKey

fn to_veilid_api_error_argument(&self) -> String

Render this value as a string for inclusion in a VeilidAPIError message field.

impl<'a> TryFrom<&'a [u8]> for SecretKey

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

Errors with VeilidAPIError::Generic if b is shorter than the 4-byte kind prefix.

type Error = VeilidAPIError

The type returned in the event of a conversion error.

impl TryFrom<&str> for SecretKey

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for SecretKey

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SecretKey

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(b: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.