Struct PollStartEventContent

#[non_exhaustive]
pub struct PollStartEventContent {
    pub poll: PollContentBlock,
    pub text: TextContentBlock,
    pub relates_to: Option<Relation<PollStartEventContentWithoutRelation>>,
}

The payload for a poll start event.

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 start event for a room version that does not support extensible events, use UnstablePollStartEventContent.

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.

poll: PollContentBlock

The poll content of the message.

text: TextContentBlock

Text representation of the message, for clients that don’t support polls.

relates_to: Option<Relation<PollStartEventContentWithoutRelation>>

Information about related messages.

Implementations

impl PollStartEventContent

pub fn new( text: TextContentBlock, poll: PollContentBlock, ) -> PollStartEventContent

Creates a new PollStartEventContent with the given fallback representation and poll content.

pub fn with_plain_text( plain_text: impl Into<String>, poll: PollContentBlock, ) -> PollStartEventContent

Creates a new PollStartEventContent with the given plain text fallback representation and poll content.

Trait Implementations

impl Clone for PollStartEventContent

fn clone(&self) -> PollStartEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PollStartEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PollStartEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for PollStartEventContent

type EventType = MessageLikeEventType

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

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

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

impl From<PollStartEventContent> for AnyMessageLikeEventContent

fn from(c: PollStartEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl From<PollStartEventContent> for PollStartEventContentWithoutRelation

fn from(c: PollStartEventContent) -> PollStartEventContentWithoutRelation

Converts to this type from the input type.

impl RedactContent for PollStartEventContent

type Redacted = RedactedPollStartEventContent

The redacted form of the event’s content.

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

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

impl Serialize for PollStartEventContent

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 PollStartEventContent

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

The event type.

impl MessageLikeEventContent for PollStartEventContent