Struct SignOptions 

#[non_exhaustive]
pub struct SignOptions {
    pub context: Option<Vec<String>>,
    pub created: Option<DateTime<Utc>>,
    pub cryptosuite: Option<CryptoSuite>,
    pub proof_purpose: Option<String>,
}

Options for signing a Data Integrity proof.

Construct via SignOptions::new (or SignOptions::default) then chain with_* methods. All fields default to None / empty; the library fills in spec-compliant defaults (current time for created, "assertionMethod" for proof_purpose, the signer’s declared cryptosuite) where they are not overridden here.

SignOptions is #[non_exhaustive] from the outside: construct it only via the provided methods, not struct-literal syntax.

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.

context: Option<Vec<String>>

JSON-LD @context values to place on the proof. If None, the document’s own @context is used (for RDFC canonicalization) or no context is emitted (for JCS).

created: Option<DateTime<Utc>>

Proof creation timestamp. If None, Utc::now() is used.

cryptosuite: Option<CryptoSuite>

Overrides the signer’s declared cryptosuite. If None, the library uses signer.cryptosuite().

proof_purpose: Option<String>

Value of proofPurpose. Defaults to "assertionMethod".

Implementations

impl SignOptions

pub fn new() -> Self

Constructs an empty SignOptions. Equivalent to SignOptions::default.

pub fn with_context(self, context: Vec<String>) -> Self

Sets the @context value placed on the emitted proof.

pub fn with_created(self, created: DateTime<Utc>) -> Self

Sets the created timestamp. Takes a typed DateTime<Utc>; the library serialises it to ISO-8601 (seconds precision, Z-suffix) at the serde boundary.

pub fn with_cryptosuite(self, suite: CryptoSuite) -> Self

Overrides the cryptosuite that would otherwise be chosen by the signer’s default (crate::signer::Signer::cryptosuite).

pub fn with_proof_purpose(self, purpose: impl Into<String>) -> Self

Overrides proofPurpose. The default is "assertionMethod".

Trait Implementations

impl Clone for SignOptions

fn clone(&self) -> SignOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignOptions

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

Formats the value using the given formatter.

impl Default for SignOptions

fn default() -> SignOptions

Returns the “default value” for a type.