Struct jws::Error

pub struct Error { /* private fields */ }

An error that can occur during JWS processing.

An error consists of an ErrorKind indicating the type of error, and a human readable message.

The message is purely for human consumption. It should not be used by error handling code to change handling logic.

Implementations

impl Error

pub const Other: ErrorKind = ErrorKind::Other

pub const MissingHeaderParam: ErrorKind = ErrorKind::MissingHeaderParam

pub const InvalidHeaderParam: ErrorKind = ErrorKind::InvalidHeaderParam

pub const UnsupportedMacAlgorithm: ErrorKind = ErrorKind::UnsupportedMacAlgorithm

pub const InvalidMessage: ErrorKind = ErrorKind::InvalidMessage

pub const InvalidSignature: ErrorKind = ErrorKind::InvalidSignature

pub fn kind(&self) -> ErrorKind

Get the kind of error.

pub fn message(&self) -> &str

Get the error message.

pub fn other(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::Other with a given message.

pub fn missing_header_param(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::MissingHeaderParam with a given message.

pub fn invalid_header_param(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::InvalidHeaderParam with a given message.

pub fn unsupported_mac_algorithm(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::UnsupportedMacAlgorithm with a given message.

pub fn invalid_message(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::InvalidMessage with a given message.

pub fn invalid_signature(message: impl Into<String>) -> Self

Create a new error of type ErrorKind::InvalidSignature with a given message.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.