Struct SignedUrlOptions 

#[non_exhaustive]
pub struct SignedUrlOptions {
    pub extra_query: Vec<(String, String)>,
    pub signed_headers: HeaderMap,
}

Available on crate feature cloud-base only.

Additional parameters to fold into a presigned URL’s signature, used with Signer::signed_url_opts.

All values are fixed at signing time: the recipient of the presigned URL must send exactly these query parameters and headers, with these values, for the request to be accepted.

Construct with SignedUrlOptions::default (or the builder methods) and set only the fields you need, so that future additions remain backwards compatible:

let options = SignedUrlOptions::default()
    .with_query([("partNumber", "1"), ("uploadId", "abc123")])
    .with_signed_header(CONTENT_TYPE, HeaderValue::from_static("text/plain"));

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.

extra_query: Vec<(String, String)>

Query parameters to sign and append to the URL.

Used for requests that carry signed query parameters — for example a multipart UploadPart (partNumber, uploadId) or pinning a versionId.

signed_headers: HeaderMap

Request headers to bind to the signature.

Used to require the recipient to send specific headers, such as a checksum (x-amz-checksum-sha256), content-type, or server-side-encryption headers.

Implementations

impl SignedUrlOptions

pub fn new() -> Self

Create an empty set of options, equivalent to SignedUrlOptions::default.

pub fn with_query<I, K, V>(self, query: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Append query parameters to sign.

pub fn with_signed_header(self, name: HeaderName, value: HeaderValue) -> Self

Bind a request header to the signature.

pub fn is_empty(&self) -> bool

Returns true if no extra query parameters or signed headers have been set.

Trait Implementations

impl Clone for SignedUrlOptions

fn clone(&self) -> SignedUrlOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignedUrlOptions

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

Formats the value using the given formatter.

impl Default for SignedUrlOptions

fn default() -> SignedUrlOptions

Returns the “default value” for a type.