Enum SigningParams

#[non_exhaustive]
pub enum SigningParams<'a> {
    V4(SigningParams<'a, SigningSettings>),
    V4a(SigningParams<'a, SigningSettings>),
}

Available on crate feature sign-http only.

Parameters for signing an HTTP request.

Variants (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.

V4(SigningParams<'a, SigningSettings>)

Sign with the SigV4 algorithm

V4a(SigningParams<'a, SigningSettings>)

Available on crate feature sigv4a only.

Sign with the SigV4a algorithm

Implementations

impl<'a> SigningParams<'a>

pub fn region(&self) -> Option<&str>

If the signing params are for SigV4, return the region. Otherwise, return None.

pub fn region_set(&self) -> Option<&str>

Available on crate feature sigv4a only.

If the signing params are for SigV4a, return the region set. Otherwise, return None.

pub fn settings(&self) -> &SigningSettings

Return a reference to the settings held by the signing params.

pub fn settings_mut(&mut self) -> &mut SigningSettings

Return a mutable reference to the settings held by the signing params.

pub fn time(&self) -> &SystemTime

Return a reference to the time in the signing params.

pub fn name(&self) -> &str

Return a reference to the name in the signing params.

pub fn algorithm(&self) -> &'static str

Return the name of the configured signing algorithm.

pub fn signature_version(&self) -> SignatureVersion

Return the name of the signing scheme

Trait Implementations

impl<'a> Debug for SigningParams<'a>

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

Formats the value using the given formatter.

impl<'a> From<SigningParams<'a, SigningSettings>> for SigningParams<'a>

fn from(value: SigningParams<'a, SigningSettings>) -> Self

Converts to this type from the input type.

impl<'a> From<SigningParams<'a, SigningSettings>> for SigningParams<'a>

Available on crate feature sigv4a only.

fn from(value: SigningParams<'a, SigningSettings>) -> Self

Converts to this type from the input type.