Struct Comment 

pub struct Comment<Meta, S> {
    pub meta: Meta,
    pub calculation_list: S,
    pub notify: Option<String>,
    pub status: Status,
    pub commands: Commands,
    pub max_length: usize,
}

The primary abstraction. Construct -> Extract -> Calculate -> Get Reply

Uses a generic for Metadata (meta).

Uses three type-states exposed as the aliases CommentConstructed, CommentExtracted, and CommentCalculated.

Fields

meta: Meta

Metadata (generic)

calculation_list: S

Data for the current step

notify: Option<String>

If Some will prepend a “Hey {string}!” to the reply.

status: Status

commands: Commands

max_length: usize

How long the reply may at most be

Implementations

impl<Meta> Comment<Meta, String>

pub fn new( comment_text: &str, meta: Meta, pre_commands: Commands, max_length: usize, ) -> Self

Takes a raw comment, finds the factorials and commands, and packages it, also checks if it might have something to calculate.

pub fn extract(self) -> CommentExtracted<Meta>

Extracts the calculations using parse.

pub fn new_already_replied(meta: Meta, max_length: usize) -> Self

Constructs an empty comment with Status already_replied_or_rejected set.

impl<Meta, S> Comment<Meta, S>

pub fn add_status(&mut self, status: Status)

impl<Meta> Comment<Meta, Vec<CalculationJob>>

pub fn calc(self) -> CommentCalculated<Meta>

Does the calculations using calculation_tasks.

impl<Meta> Comment<Meta, Vec<Calculation>>

pub fn get_reply(&self) -> String

Does the formatting for the reply using calculation_result.

Trait Implementations

impl<Meta: Clone, S: Clone> Clone for Comment<Meta, S>

fn clone(&self) -> Comment<Meta, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Meta: Debug, S: Debug> Debug for Comment<Meta, S>

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

Formats the value using the given formatter.

impl<Meta: Ord, S: Ord> Ord for Comment<Meta, S>

fn cmp(&self, other: &Comment<Meta, S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Meta: PartialEq, S: PartialEq> PartialEq for Comment<Meta, S>

fn eq(&self, other: &Comment<Meta, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Meta: PartialOrd, S: PartialOrd> PartialOrd for Comment<Meta, S>

fn partial_cmp(&self, other: &Comment<Meta, S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Meta: Eq, S: Eq> Eq for Comment<Meta, S>

impl<Meta, S> StructuralPartialEq for Comment<Meta, S>