Enum ruma_common::events::key::verification::cancel::CancelCode
source · [−]#[non_exhaustive]
pub enum CancelCode {
User,
Timeout,
UnknownTransaction,
UnknownMethod,
UnexpectedMessage,
KeyMismatch,
UserMismatch,
InvalidMessage,
Accepted,
MismatchedCommitment,
MismatchedSas,
// some variants omitted
}
events
only.Expand description
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)
This enum is marked as non-exhaustive
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
sourceimpl CancelCode
impl CancelCode
Trait Implementations
sourceimpl AsRef<str> for CancelCode
impl AsRef<str> for CancelCode
sourceimpl Clone for CancelCode
impl Clone for CancelCode
sourcefn clone(&self) -> CancelCode
fn clone(&self) -> CancelCode
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for CancelCode
impl Debug for CancelCode
sourceimpl<'de> Deserialize<'de> for CancelCode
impl<'de> Deserialize<'de> for CancelCode
sourcefn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
sourceimpl Display for CancelCode
impl Display for CancelCode
sourceimpl PartialEq<CancelCode> for CancelCode
impl PartialEq<CancelCode> for CancelCode
sourcefn eq(&self, other: &CancelCode) -> bool
fn eq(&self, other: &CancelCode) -> bool
sourceimpl Serialize for CancelCode
impl Serialize for CancelCode
impl Eq for CancelCode
impl StructuralEq for CancelCode
impl StructuralPartialEq for CancelCode
Auto Trait Implementations
impl RefUnwindSafe for CancelCode
impl Send for CancelCode
impl Sync for CancelCode
impl Unpin for CancelCode
impl UnwindSafe for CancelCode
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.