Struct scratchstack_aws_signature::SigningKey

pub struct SigningKey {
    pub kind: SigningKeyKind,
    pub key: Vec<u8>,
}

A signing key of some type.

Fields

kind: SigningKeyKind

key: Vec<u8>

Implementations

impl SigningKey

pub fn try_derive<R, S>(
    &self,
    derived_key_kind: SigningKeyKind,
    req_date: &Date<Utc>,
    region: R,
    service: S
) -> Result<Self, SignatureError> where
    R: AsRef<str>,
    S: AsRef<str>, 

Convert this key into the specified kind of key.

This function returns an error if the existing key cannot be derived into the dervied key kind.

pub fn try_to_kservice_key<R, S>(
    &self,
    req_date: &Date<Utc>,
    region: R,
    service: S
) -> Result<Self, SignatureError> where
    R: AsRef<str>,
    S: AsRef<str>, 

Return a KService key given a KService, KRegion, KDate, or KSecret key.

This function returns an error if given a KSigning key.

pub fn try_to_kregion_key<R>(
    &self,
    req_date: &Date<Utc>,
    region: R
) -> Result<Self, SignatureError> where
    R: AsRef<str>, 

Return a KRegion key given a KRegion, KDate, or KSecret key.

This function returns an error if given a KSigning or KService key.

pub fn try_to_kdate_key(
    &self,
    req_date: &Date<Utc>
) -> Result<Self, SignatureError>

Return a KDate key given a KDate or KSecret key.

This function returns an error if given a KRegion, KSigning, or KService key.

pub fn derive<R, S>(
    &self,
    derived_key_kind: SigningKeyKind,
    req_date: &Date<Utc>,
    region: R,
    service: S
) -> Self where
    R: AsRef<str>,
    S: AsRef<str>, 

Convert this key into the specified kind of key.

This function panics if the existing key cannot be derived into the dervied key kind. Use try_derive for a non-panicking version.

pub fn to_ksigning_key<R, S>(
    &self,
    req_date: &Date<Utc>,
    region: R,
    service: S
) -> Self where
    R: AsRef<str>,
    S: AsRef<str>, 

Return a KSigning key given a KSigning, KService, KRegion, KDate, or KSecret key.

This function is infallible (does not panic).

pub fn to_kservice_key<R, S>(
    &self,
    req_date: &Date<Utc>,
    region: R,
    service: S
) -> Self where
    R: AsRef<str>,
    S: AsRef<str>, 

Return a KService key given a KService, KRegion, KDate, or KSecret key.

This function panics an error if given a KSigning key. Use try_to_kservice_key for a non-panicking version,.

pub fn to_kregion_key<R>(&self, req_date: &Date<Utc>, region: R) -> Self where
    R: AsRef<str>, 

Return a KRegion key given a KRegion, KDate, or KSecret key.

This function panics if given a KSigning or KService key. Use try_to_kregion_key for a for a non-panicking version.

pub fn to_kdate_key(&self, req_date: &Date<Utc>) -> Self

Return a KDate key given a KDate or KSecret key.

This function panics if given a KRegion, KSigning, or KService key. Use try_to_kdate_key for a non-panicking version.

Trait Implementations

impl Clone for SigningKey

fn clone(&self) -> SigningKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningKey

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

Formats the value using the given formatter.