Struct JWSBuilder

pub struct JWSBuilder { /* private fields */ }

JWSBuilder should be used when manually creating a JWS, JWSCompact or JWSFlattened

Implementations

impl JWSBuilder

pub fn new() -> JWSBuilder

Create a new builder

pub fn with_payload(self, payload: impl AsRef<[u8]>) -> JWSBuilder

Add the provided payload to this JWSBuilder

pub fn set_payload(&mut self, payload: impl AsRef<[u8]>) -> &mut JWSBuilder

Add the provided payload to this JWSBuilder

pub fn try_with_protected_header( self, name: String, value: impl Serialize, ) -> Result<JWSBuilder, OpaqueError>

Set provided header in the protected header map

Warning: this function will replace already existing headers If more control is needed, use Self::protected_headers_mut to get access to the underlying header store

pub fn try_set_protected_header( &mut self, name: String, value: impl Serialize, ) -> Result<&mut JWSBuilder, OpaqueError>

Set provided header in the protected header map

Warning: this function will replace already existing headers If more control is needed, use Self::protected_headers_mut to get access to the underlying header store

pub fn try_with_protected_headers( self, headers: impl Serialize, ) -> Result<JWSBuilder, OpaqueError>

Set provided headers in the protected header map

Warning: this function will replace already existing headers If more control is needed, use[Self::protected_headers_mut] to get access to the underlying header store

pub fn try_set_protected_headers( &mut self, headers: impl Serialize, ) -> Result<&mut JWSBuilder, OpaqueError>

Set provided headers in the protected header map

Warning: this function will replace already existing headers If more control is needed, use[Self::protected_headers_mut] to get access to the underlying header store

pub fn protected_headers_mut(&mut self) -> &mut Headers

Get mutable reference to the underlying protected header store

This can be used in cases where more granual control is needed

pub fn try_with_unprotected_header( self, name: String, value: impl Serialize, ) -> Result<JWSBuilder, OpaqueError>

Set provided header in the unprotected header map

Warning: this function will replace already existing headers If more control is needed, use Self::unprotected_headers_mut to get access to the underlying header store

pub fn try_set_unprotected_header( &mut self, name: String, value: impl Serialize, ) -> Result<&mut JWSBuilder, OpaqueError>

Set provided header in the unprotected header map

Warning: this function will replace already existing headers If more control is needed, use Self::unprotected_headers_mut to get access to the underlying header store

pub fn try_with_unprotected_headers( self, headers: impl Serialize, ) -> Result<JWSBuilder, OpaqueError>

Set provided headers in the unprotected header map

Warning: this function will replace already existing headers If more control is needed, use Self::unprotected_headers_mut to get access to the underlying header store

pub fn try_set_unprotected_headers( &mut self, headers: impl Serialize, ) -> Result<&mut JWSBuilder, OpaqueError>

Set provided headers in the unprotected header map

Warning: this function will replace already existing headers If more control is needed, use Self::unprotected_headers_mut to get access to the underlying header store

pub fn unprotected_headers_mut(&mut self) -> &mut Headers

Get mutable reference to the underlying unprotected header store

This can be used in cases where more granual control is needed

pub fn build_compact( self, signer: &impl Signer, ) -> Result<JWSCompact, OpaqueError>

Generate compact serialization of this JWS

This only available if there is no unprotected header set

pub fn build_flattened( self, signer: &impl Signer, ) -> Result<JWSFlattened, OpaqueError>

Build a JWSFlattened

pub fn build_jws(self, signer: &impl Signer) -> Result<JWS, OpaqueError>

Build a JWS

pub fn add_signature( self, signer: &impl Signer, ) -> Result<ChainedJWSBuilder, OpaqueError>

Create a [ChainedJWSBuilder] with the same payload but that can add a new set of headers and which will be signed again. This is needed to create a JWS with multiple signatures.

Trait Implementations

impl Clone for JWSBuilder

fn clone(&self) -> JWSBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JWSBuilder

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

Formats the value using the given formatter.

impl Default for JWSBuilder

fn default() -> JWSBuilder

Returns the “default value” for a type.

impl PartialEq for JWSBuilder

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

impl StructuralPartialEq for JWSBuilder