Struct Paragraph 

pub struct Paragraph {
    pub events: Vec<(String, Context)>,
    pub relations: Vec<Option<RstRelation>>,
    pub salience: Salience,
    pub category: Option<RhetoricalCategory>,
}

A paragraph in a document plan — a group of related events rendered together.

Fields

events: Vec<(String, Context)>

The events in this paragraph, in render order.

relations: Vec<Option<RstRelation>>

Optional rhetorical relation for each event. relations[i] describes the relation between events[i] and events[i-1]. relations[0] is conventionally None (no predecessor within the paragraph). Same length as events.

salience: Salience

The highest salience in this paragraph, used for ordering.

category: Option<RhetoricalCategory>

Rhetorical category, when the plan was built with GroupingStrategy::ByAction. None for entity-grouped plans.

Implementations

impl Paragraph

pub fn new() -> Self

pub fn push(&mut self, key: String, ctx: Context, salience: Salience)

Push an event with no rhetorical relation (None).

pub fn push_with_relation( &mut self, key: String, ctx: Context, salience: Salience, relation: Option<RstRelation>, )

Push an event with an optional RST relation to its predecessor.

The relation describes how this event relates to the immediately preceding event in the same paragraph. Pass None when there is no predecessor or when the rhetorical link is unknown.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Paragraph

fn clone(&self) -> Paragraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Default for Paragraph

fn default() -> Self

Returns the “default value” for a type.