Struct CavageHeaderParams 

#[non_exhaustive]
pub struct CavageHeaderParams {
    pub key_id: String,
    pub algorithm: Option<String>,
    pub headers: CavageHeaderSet,
    pub signature: String,
    pub created: Option<i64>,
    pub expires: Option<i64>,
}

Parsed Signature: header 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.

key_id: String

Reference to the public key to verify against.

algorithm: Option<String>

Algorithm hint; None means “detect from the key itself”.

headers: CavageHeaderSet

Which headers participate in the signature base string.

signature: String

Base64-encoded signature bytes.

created: Option<i64>

Optional (created) timestamp in seconds since the UNIX epoch.

expires: Option<i64>

Optional (expires) timestamp in seconds since the UNIX epoch.

Implementations

impl CavageHeaderParams

pub fn parse(raw: &str) -> Result<Self, Error>

Parses the raw Signature: header value.

Errors

Returns Error::MalformedSignatureHeader if the parameter list cannot be decoded, and Error::MissingSignatureParameter if keyId or signature is absent.

pub fn to_header_value(&self) -> String

Serialises back into a Signature: header value.

String-valued parameters (keyId, algorithm, headers, signature) are quoted and any \ or " character inside them is backslash-escaped per the Cavage quoted-string grammar.

Trait Implementations

impl Clone for CavageHeaderParams

fn clone(&self) -> CavageHeaderParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CavageHeaderParams

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

Formats the value using the given formatter.

impl PartialEq for CavageHeaderParams

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

impl StructuralPartialEq for CavageHeaderParams