Enum CancelCode

#[non_exhaustive]
pub enum CancelCode {
    User,
    Timeout,
    UnknownTransaction,
    UnknownMethod,
    UnexpectedMessage,
    KeyMismatch,
    UserMismatch,
    InvalidMessage,
    Accepted,
    MismatchedCommitment,
    MismatchedSas,
}

An error code for why the process/request was cancelled by the user.

Custom error codes should use the Java package naming convention.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

User

The user cancelled the verification.

Timeout

The verification process timed out.

Verification processes can define their own timeout parameters.

UnknownTransaction

The device does not know about the given transaction ID.

UnknownMethod

The device does not know how to handle the requested method.

Should be sent for m.key.verification.start messages and messages defined by individual verification processes.

UnexpectedMessage

The device received an unexpected message.

Typically raised when one of the parties is handling the verification out of order.

KeyMismatch

The key was not verified.

UserMismatch

The expected user did not match the user verified.

InvalidMessage

The message received was invalid.

Accepted

An m.key.verification.request was accepted by a different device.

The device receiving this error can ignore the verification request.

MismatchedCommitment

The device receiving this error can ignore the verification request.

MismatchedSas

The SAS did not match.

Implementations

impl CancelCode

pub fn as_str(&self) -> &str

Creates a string slice from this CancelCode.

Trait Implementations

impl AsRef<str> for CancelCode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CancelCode

fn clone(&self) -> CancelCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CancelCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelCode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CancelCode

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

Formats the value using the given formatter.

impl<T> From<T> for CancelCode

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq for CancelCode

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CancelCode

impl StructuralPartialEq for CancelCode