Enum PollSpec 

pub enum PollSpec {
    Ranked {
        options: Vec<PollOptionSpec>,
        max_ranks: Option<u16>,
        opens_at: Option<DateTime<Utc>>,
        closes_at: DateTime<Utc>,
    },
    Approval {
        options: Vec<PollOptionSpec>,
        max_choices: Option<u16>,
        opens_at: Option<DateTime<Utc>>,
        closes_at: DateTime<Utc>,
    },
    Single {
        options: Vec<PollOptionSpec>,
        opens_at: Option<DateTime<Utc>>,
        closes_at: DateTime<Utc>,
    },
}

A poll to attach to a new post (create_post’s poll), tagged by its mode. Each mode carries only its own parameters.

Its schema is written by hand (see the JsonSchema impl): one closed object, mode an enum, and one max_choices that caps the options a ballot may rank (ranked) or approve (approval), so the poll is written out once (0.106; it was an anyOf with one object per mode). ranked reads max_choices as max_ranks, and still reads max_ranks, so the signed bytes, which serialize max_ranks, are unchanged. No $ref and no pattern; the bounds are checked by PollSpec::check too, with an error that says what to fix.

Variants

Ranked

Ranked choice, counted by instant runoff

Fields

options: Vec<PollOptionSpec>

max_ranks: Option<u16>

The most options one ballot may rank; every option when absent

opens_at: Option<DateTime<Utc>>

When voting opens; now when absent

closes_at: DateTime<Utc>

When voting closes and the ballots are counted

Approval

Approval: a ballot names every option its voter approves of

Fields

options: Vec<PollOptionSpec>

max_choices: Option<u16>

The most options one ballot may approve; every option when absent

opens_at: Option<DateTime<Utc>>

closes_at: DateTime<Utc>

Single

A ballot names exactly one option

Fields

options: Vec<PollOptionSpec>

opens_at: Option<DateTime<Utc>>

closes_at: DateTime<Utc>

Implementations

impl PollSpec

pub fn mode(&self) -> PollMode

The poll’s mode

pub fn options(&self) -> &[PollOptionSpec]

Its options, as written

pub fn check(&self, now: DateTime<Utc>) -> Result<CheckedPoll, PollSpecError>

Check every bound the schema cannot carry, against the clock now

Trait Implementations

impl Clone for PollSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PollSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PollSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PollSpec

impl PartialEq for PollSpec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PollSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PollSpec