Struct jws::compact::DecodedMessage

pub struct DecodedMessage {
    pub header: JsonObject,
    pub payload: Vec<u8>,
}

A compact JWS message with header and payload, but without signature.

The signature is left off because the signature can only be computed from (and verified for) a serialized message, whereas this struct represents a mostly decoded message (the payload is still raw bytes).

You can call decode_verify to decode and verify a message. Alternatively, you can call split_encoded_parts, decode the parts and then use a Verifier manually. The latter allows you to access the decoded message, even if it’s signature is invalid.

Fields

header: JsonObject

payload: Vec<u8>

Implementations

impl DecodedMessage

pub fn new(header: impl Into<JsonObject>, payload: impl Into<Vec<u8>>) -> Self

Create a new message from a header and a payload.

pub fn from_encoded_parts(header: &[u8], payload: &[u8]) -> Result<Self>

Create a new DecodedMessage by decoding the header and payload of a JWS Compact Serialization message.

pub fn parse_json<'de, T: Deserialize<'de> + 'de>(&'de self) -> Result<T, Error>

Parse the payload as JSON using serde.

The type must implement the serde::Deserialize trait

pub fn parse_json_value(&self) -> Result<JsonValue, Error>

Parse the payload as a JsonValue.

This method avoids the need for type annotations.

pub fn parse_json_object(&self) -> Result<JsonObject, Error>

Parse the payload as a JsonObject.

This method avoids the need for type annotations.

Trait Implementations

impl Clone for DecodedMessage

fn clone(&self) -> DecodedMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecodedMessage

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

Formats the value using the given formatter.

impl PartialEq<DecodedMessage> for DecodedMessage

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