Struct SigningSettings

#[non_exhaustive]
pub struct SigningSettings {
    pub percent_encoding_mode: PercentEncodingMode,
    pub payload_checksum_kind: PayloadChecksumKind,
    pub signature_location: SignatureLocation,
    pub expires_in: Option<Duration>,
    pub excluded_headers: Option<Vec<Cow<'static, str>>>,
    pub uri_path_normalization_mode: UriPathNormalizationMode,
    pub session_token_mode: SessionTokenMode,
    pub session_token_name_override: Option<&'static str>,
}

Available on crate feature sign-http only.

HTTP-specific signing settings

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

percent_encoding_mode: PercentEncodingMode

Specifies how to encode the request URL when signing. Some services do not decode the path prior to checking the signature, requiring clients to actually double-encode the URI in creating the canonical request in order to pass a signature check.

payload_checksum_kind: PayloadChecksumKind

Add an additional checksum header

signature_location: SignatureLocation

Where to put the signature

expires_in: Option<Duration>

For presigned requests, how long the presigned request is valid for

excluded_headers: Option<Vec<Cow<'static, str>>>

Headers that should be excluded from the signing process

uri_path_normalization_mode: UriPathNormalizationMode

Specifies whether the absolute path component of the URI should be normalized during signing.

session_token_mode: SessionTokenMode

Some services require X-Amz-Security-Token to be included in the canonical request. Other services require only it to be added after calculating the signature.

session_token_name_override: Option<&'static str>

Some services require an alternative session token header or query param instead of x-amz-security-token or X-Amz-Security-Token.

Trait Implementations

impl Clone for SigningSettings

fn clone(&self) -> SigningSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningSettings

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

Formats the value using the given formatter.

impl Default for SigningSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SigningSettings

fn eq(&self, other: &SigningSettings) -> 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 StructuralPartialEq for SigningSettings