Struct SignedWatermarkParams 

pub struct SignedWatermarkParams {
    pub url: String,
    pub position: Option<String>,
    pub opacity: Option<u8>,
    pub margin: Option<u32>,
}

Builds a signed public transform URL for the server adapter.

The resulting URL targets either GET /images/by-path or GET /images/by-url depending on source. base_url must be an absolute http or https URL that points at the externally visible server origin. The helper applies the same canonical query and HMAC-SHA256 signature scheme that the server adapter verifies at request time.

The helper serializes only explicitly requested transform options and omits fields that would resolve to the documented defaults on the server side.

Errors

Returns an error string when base_url is not an absolute http or https URL, when the visible authority cannot be determined, or when the HMAC state cannot be initialized.

Examples

use truss::adapters::server::{sign_public_url, SignedUrlSource};
use truss::{MediaType, TransformOptions};

let url = sign_public_url(
    "https://cdn.example.com",
    SignedUrlSource::Path {
        path: "/image.png".to_string(),
        version: None,
    },
    &TransformOptions {
        format: Some(MediaType::Jpeg),
        ..TransformOptions::default()
    },
    "public-dev",
    "secret-value",
    4_102_444_800,
    None,
    None,
)
.unwrap();

assert!(url.starts_with("https://cdn.example.com/images/by-path?"));
assert!(url.contains("keyId=public-dev"));
assert!(url.contains("signature="));

Optional watermark parameters for signed URL generation.

Fields

url: String

position: Option<String>

opacity: Option<u8>

margin: Option<u32>

Trait Implementations

impl Debug for SignedWatermarkParams

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

Formats the value using the given formatter.

impl Default for SignedWatermarkParams

fn default() -> SignedWatermarkParams

Returns the “default value” for a type.