Enum ruma_client_api::delayed_events::DelayParameters

#[non_exhaustive]
pub enum DelayParameters {
    Timeout {
        timeout: Duration,
    },
}

The query parameters for a delayed event request. It contains the timeout configuration for a delayed event.

Note:

This is an Enum since the following properties might be added:

The Timeout case might get an additional optional delay_parent_id property. The optional parent id is used to create a secondary timeout.
In a delay group with two timeouts only one of them will ever be sent.

The Action case might be added: Adds an additional action to a delay event without a timeout but requires a delay_id (of the parent delay event). A possible matrix event that can be send as an alternative to the parent delay.

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.

Timeout

Sending a delayed event with a timeout. The response will contain a (server generated) delay_id instead of an event_id.

Fields

timeout: Duration

The timeout duration for this delayed event.

Trait Implementations

impl Clone for DelayParameters

fn clone(&self) -> DelayParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DelayParameters

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DelayParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DelayParameters

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

where __S: Serializer,

Serialize this value into the given Serde serializer.