Struct identity_iota::storage::JwsSignatureOptions

#[non_exhaustive]
pub struct JwsSignatureOptions {
    pub attach_jwk: bool,
    pub b64: Option<bool>,
    pub typ: Option<String>,
    pub cty: Option<String>,
    pub url: Option<Url>,
    pub nonce: Option<String>,
    pub kid: Option<String>,
    pub detached_payload: bool,
    pub custom_header_parameters: Option<BTreeMap<String, Value>>,
}

Options for creating a JSON Web Signature.

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.

attach_jwk: bool

Whether to attach the public key in the corresponding method to the JWS header.

b64: Option<bool>

Whether to Base64url encode the payload or not.

More Info

typ: Option<String>

The Type value to be placed in the protected header.

More Info

cty: Option<String>

Content Type to be placed in the protected header.

More Info

url: Option<Url>

The URL to be placed in the protected header.

More Info

nonce: Option<String>

The nonce to be placed in the protected header.

More Info

kid: Option<String>

The kid to set in the protected header.

If unset, the kid of the JWK with which the JWS is produced is used.

More Info

detached_payload: bool

Whether the payload should be detached from the JWS.

More Info.

custom_header_parameters: Option<BTreeMap<String, Value>>

Additional header parameters.

Implementations

impl JwsSignatureOptions

pub fn new() -> JwsSignatureOptions

Creates a new JwsSignatureOptions.

pub fn attach_jwk_to_header(self, value: bool) -> JwsSignatureOptions

Replace the value of the attach_jwk field.

pub fn b64(self, value: bool) -> JwsSignatureOptions

Replace the value of the b64 field.

pub fn typ(self, value: impl Into<String>) -> JwsSignatureOptions

Replace the value of the typ field.

pub fn cty(self, value: impl Into<String>) -> JwsSignatureOptions

Replace the value of the cty field.

pub fn url(self, value: Url) -> JwsSignatureOptions

Replace the value of the url field.

pub fn nonce(self, value: impl Into<String>) -> JwsSignatureOptions

Replace the value of the nonce field.

pub fn kid(self, value: impl Into<String>) -> JwsSignatureOptions

Replace the value of the kid field.

pub fn detached_payload(self, value: bool) -> JwsSignatureOptions

Replace the value of the detached_payload field.

pub fn custom_header_parameters( self, value: BTreeMap<String, Value> ) -> JwsSignatureOptions

Adds additional header parameters.

Trait Implementations

impl Clone for JwsSignatureOptions

fn clone(&self) -> JwsSignatureOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwsSignatureOptions

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

Formats the value using the given formatter.

impl Default for JwsSignatureOptions

fn default() -> JwsSignatureOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JwsSignatureOptions

where JwsSignatureOptions: Default,

fn deserialize<__D>( __deserializer: __D ) -> Result<JwsSignatureOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JwsSignatureOptions

fn eq(&self, other: &JwsSignatureOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JwsSignatureOptions

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JwsSignatureOptions

impl StructuralPartialEq for JwsSignatureOptions