Struct ruma_events::secret_storage::key::SecretStorageKeyEventContent

#[non_exhaustive]
pub struct SecretStorageKeyEventContent {
    pub key_id: String,
    pub name: Option<String>,
    pub algorithm: SecretStorageEncryptionAlgorithm,
    pub passphrase: Option<PassPhrase>,
}

A key description encrypted using a specified algorithm.

The only algorithm currently specified is m.secret_storage.v1.aes-hmac-sha2, so this essentially represents AesHmacSha2KeyDescription in the spec.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_id: String

The ID of the key.

name: Option<String>

The name of the key.

algorithm: SecretStorageEncryptionAlgorithm

The encryption algorithm used for this key.

Currently, only m.secret_storage.v1.aes-hmac-sha2 is supported.

passphrase: Option<PassPhrase>

The passphrase from which to generate the key.

Implementations

impl SecretStorageKeyEventContent

pub fn new(key_id: String, algorithm: SecretStorageEncryptionAlgorithm) -> Self

Creates a KeyDescription with the given name.

Trait Implementations

impl Clone for SecretStorageKeyEventContent

fn clone(&self) -> SecretStorageKeyEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretStorageKeyEventContent

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

Formats the value using the given formatter.

impl EventContent for SecretStorageKeyEventContent

type EventType = GlobalAccountDataEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl EventContentFromType for SecretStorageKeyEventContent

fn from_parts(ev_type: &str, content: &RawValue) -> Result<Self>

Constructs this event content from the given event type and JSON.

impl From<SecretStorageKeyEventContent> for AnyGlobalAccountDataEventContent

fn from(c: SecretStorageKeyEventContent) -> Self

Converts to this type from the input type.

impl Serialize for SecretStorageKeyEventContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for SecretStorageKeyEventContent

const TYPE: &'static str = "m.secret_storage.key.*"

The event type.

impl GlobalAccountDataEventContent for SecretStorageKeyEventContent