ruma_events/poll/
unstable_end.rs

Help
1//! Types for the `org.matrix.msc3381.poll.end` event, the unstable version of `m.poll.end`.
2
3use ruma_common::OwnedEventId;
4use ruma_macros::EventContent;
5use serde::{Deserialize, Serialize};
6
7use crate::relation::Reference;
8
9/// The payload for an unstable poll end event.
10///
11/// This type can be generated from the unstable poll start and poll response events with
12/// [`OriginalSyncUnstablePollStartEvent::compile_results()`].
13///
14/// This is the event content that should be sent for room versions that don't support extensible
15/// events. As of Matrix 1.7, none of the stable room versions (1 through 10) support extensible
16/// events.
17///
18/// To send a poll end event for a room version that supports extensible events, use
19/// [`PollEndEventContent`].
20///
21/// [`OriginalSyncUnstablePollStartEvent::compile_results()`]: super::unstable_start::OriginalSyncUnstablePollStartEvent::compile_results
22/// [`PollEndEventContent`]: super::end::PollEndEventContent
23#[derive(Clone, Debug, Serialize, Deserialize, EventContent)]
24#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
25#[ruma_event(type = "org.matrix.msc3381.poll.end", kind = MessageLike)]
26pub struct UnstablePollEndEventContent {
27    /// The text representation of the results.
28    #[serde(rename = "org.matrix.msc1767.text")]
29    pub text: String,
30
31    /// The poll end content.
32    #[serde(default, rename = "org.matrix.msc3381.poll.end")]
33    pub poll_end: UnstablePollEndContentBlock,
34
35    /// Information about the poll start event this responds to.
36    #[serde(rename = "m.relates_to")]
37    pub relates_to: Reference,
38}
39
40impl UnstablePollEndEventContent {
41    /// Creates a new `PollEndEventContent` with the given fallback representation and
42    /// that responds to the given poll start event ID.
43    pub fn new(text: impl Into<String>, poll_start_id: OwnedEventId) -> Self {
44        Self {
45            text: text.into(),
46            poll_end: UnstablePollEndContentBlock {},
47            relates_to: Reference::new(poll_start_id),
48        }
49    }
50}
51
52/// A block for the results of a poll.
53///
54/// This is currently an empty struct.
55#[derive(Clone, Debug, Default, Serialize, Deserialize)]
56#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
57pub struct UnstablePollEndContentBlock {}
ruma_events/poll/unstable_end.rs

ruma_events/poll/
unstable_end.rs
