Struct PollEndEventContent

#[non_exhaustive]
pub struct PollEndEventContent {
    pub text: TextContentBlock,
    pub poll_results: Option<PollResultsContentBlock>,
    pub relates_to: Reference,
}

The payload for a poll end event.

This type can be generated from the poll start and poll response events with OriginalSyncPollStartEvent::compile_results().

This is the event content that should be sent for room versions that support extensible events. As of Matrix 1.7, none of the stable room versions (1 through 10) support extensible events.

To send a poll end event for a room version that does not support extensible events, use UnstablePollEndEventContent.

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.

text: TextContentBlock

The text representation of the results.

poll_results: Option<PollResultsContentBlock>

The sender’s perspective of the results.

relates_to: Reference

Information about the poll start event this responds to.

Implementations

impl PollEndEventContent

pub fn new( text: TextContentBlock, poll_start_id: OwnedEventId, ) -> PollEndEventContent

Creates a new PollEndEventContent with the given fallback representation and that responds to the given poll start event ID.

pub fn with_plain_text( plain_text: impl Into<String>, poll_start_id: OwnedEventId, ) -> PollEndEventContent

Creates a new PollEndEventContent with the given plain text fallback representation and that responds to the given poll start event ID.

Trait Implementations

impl Clone for PollEndEventContent

fn clone(&self) -> PollEndEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PollEndEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PollEndEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<PollEndEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for PollEndEventContent

type EventType = MessageLikeEventType

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

fn event_type(&self) -> <PollEndEventContent as EventContent>::EventType

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

impl From<PollEndEventContent> for AnyMessageLikeEventContent

fn from(c: PollEndEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl RedactContent for PollEndEventContent

type Redacted = RedactedPollEndEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedPollEndEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for PollEndEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for PollEndEventContent

const TYPE: &'static str = "m.poll.end"

The event type.

impl MessageLikeEventContent for PollEndEventContent