Enum ruma_common::EventEncryptionAlgorithm

#[non_exhaustive]
pub enum EventEncryptionAlgorithm {
    OlmV1Curve25519AesSha2,
    MegolmV1AesSha2,
}

An encryption algorithm to be used to encrypt messages sent to a room.

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.

OlmV1Curve25519AesSha2

Olm version 1 using Curve25519, AES-256, and SHA-256.

MegolmV1AesSha2

Megolm version 1 using AES-256 and SHA-256.

Implementations

impl EventEncryptionAlgorithm

pub fn as_str(&self) -> &str

Creates a string slice from this EventEncryptionAlgorithm.

Trait Implementations

impl AsRef<str> for EventEncryptionAlgorithm

fn as_ref(&self) -> &str

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

impl Clone for EventEncryptionAlgorithm

fn clone(&self) -> EventEncryptionAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventEncryptionAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventEncryptionAlgorithm

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EventEncryptionAlgorithm

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

Formats the value using the given formatter.

impl<T> From<T> for EventEncryptionAlgorithm

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

fn from(s: T) -> Self

Converts to this type from the input type.

impl Ord for EventEncryptionAlgorithm

fn cmp(&self, other: &EventEncryptionAlgorithm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EventEncryptionAlgorithm

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

fn partial_cmp(&self, other: &EventEncryptionAlgorithm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for EventEncryptionAlgorithm

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 EventEncryptionAlgorithm

impl StructuralPartialEq for EventEncryptionAlgorithm