Struct SignatureInput 

#[non_exhaustive]
pub struct SignatureInput {
    pub components: Vec<Component>,
    pub keyid: Option<String>,
    pub algorithm: Option<String>,
    pub created: Option<i64>,
    pub expires: Option<i64>,
    pub nonce: Option<String>,
    pub tag: Option<String>,
}

One entry of the Signature-Input: dictionary: the ordered component list plus parameters.

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.

components: Vec<Component>

Components covered by the signature, in signing order.

keyid: Option<String>

keyid= parameter (mandatory for ActivityPub use).

algorithm: Option<String>

alg= parameter hint; None means “detect from the resolved key”.

created: Option<i64>

created= parameter in seconds since the UNIX epoch.

expires: Option<i64>

expires= parameter in seconds since the UNIX epoch.

nonce: Option<String>

nonce= parameter as emitted by the signer, opaque to us.

tag: Option<String>

tag= parameter as emitted by the signer, opaque to us.

Implementations

impl SignatureInput

pub const fn new(components: Vec<Component>) -> Self

Creates a SignatureInput covering the given components, with every optional parameter left unset. Use the with_* builders below to populate keyid, created, expires, nonce and tag as needed.

pub fn with_keyid(self, keyid: impl Into<String>) -> Self

Sets the keyid= parameter.

pub fn with_algorithm(self, algorithm: impl Into<String>) -> Self

Sets the alg= parameter.

pub const fn with_created(self, created: i64) -> Self

Sets the created= parameter (seconds since UNIX epoch).

pub const fn with_expires(self, expires: i64) -> Self

Sets the expires= parameter (seconds since UNIX epoch).

pub fn with_nonce(self, nonce: impl Into<String>) -> Self

Sets the nonce= parameter.

pub fn with_tag(self, tag: impl Into<String>) -> Self

Sets the tag= parameter.

pub fn serialise_inner_list(&self) -> String

Serialises this entry as the inner-list-with-parameters portion that appears after label=. The full header value is built by serialise_signature_input_dict.

Panics

Panics only if sfv fails to serialise a well-formed inner list; this is unreachable for the inputs we construct.

Trait Implementations

impl Clone for SignatureInput

fn clone(&self) -> SignatureInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureInput

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

Formats the value using the given formatter.

impl Eq for SignatureInput

impl PartialEq for SignatureInput

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