Struct SignOpts 

pub struct SignOpts {
    pub domain: String,
    pub selector: String,
    pub signed_headers: Vec<String>,
    pub canon_header: Canon,
    pub canon_body: Canon,
    pub identity: Option<String>,
    pub timestamp: Option<u64>,
    pub expiration: Option<u64>,
    pub body_length: Option<u64>,
}

Options for sign.

Fields

domain: String

d= — signing domain.

selector: String

s= — selector (publishes the public key at <selector>._domainkey.<domain>).

signed_headers: Vec<String>

h= — header NAMES to sign, in order. Case-insensitive lookup against the message. Headers that don’t exist on the message are skipped (RFC 6376 §3.5).

canon_header: Canon

c= header canonicalization.

canon_body: Canon

c= body canonicalization.

identity: Option<String>

i= — optional identity (AUID).

timestamp: Option<u64>

t= — optional signature timestamp. Caller supplies because this crate avoids the std::time::SystemTime dep on the signing path (lets tests pin time).

expiration: Option<u64>

x= — optional expiration timestamp.

body_length: Option<u64>

l= — optional body-length limit. Most signers leave this unset; a few sign just the first N bytes to tolerate trailing additions.

Implementations

impl SignOpts

pub fn new(domain: impl Into<String>, selector: impl Into<String>) -> Self

Sensible defaults: relaxed/relaxed canon, no expiry, no AUID, no body-length limit. Caller still must set domain, selector, and signed_headers.

pub fn add_signed_header(self, name: impl Into<String>) -> Self

Add a single header name to the h= list.

pub fn signed_headers<I: IntoIterator<Item = S>, S: Into<String>>( self, headers: I, ) -> Self

Replace the h= list with the provided one.

pub fn timestamp(self, t: u64) -> Self

Set t=.

pub fn expiration(self, x: u64) -> Self

Set x=.

Trait Implementations

impl Clone for SignOpts

fn clone(&self) -> SignOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignOpts

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

Formats the value using the given formatter.