Struct RenderedDocument 

#[non_exhaustive]
pub struct RenderedDocument {
    pub text: String,
    pub paragraphs: Vec<RenderedParagraph>,
    pub sentences: Vec<RenderedSentence>,
    pub connectives_used: Vec<UsedConnective>,
    pub list_styles_used: Vec<UsedListStyle>,
}

A structured view of a rendered document.

Diagnosers and the composite scorer consume this rather than the flat text of crate::DocumentPlan::render. The text field always equals the same flattened-with-"\n\n" form render returns, so callers can ignore the structured fields when they don’t need them.

Population of the rich fields (connectives_used, list_styles_used, per-sentence opening connectives) happens via discourse-state introspection at render time. A RenderedDocument returned by crate::DocumentPlan::render_structured is internally consistent; hand-constructed instances (e.g. for diagnoser tests) need to populate matching data.

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: String

The flattened paragraph text, joined with "\n\n".

paragraphs: Vec<RenderedParagraph>

One entry per paragraph, in render order.

sentences: Vec<RenderedSentence>

All sentences from all paragraphs, flattened in render order. Mirrors the per-paragraph nesting and exists as a convenience for scorers that don’t care about paragraph boundaries.

connectives_used: Vec<UsedConnective>

Connectives emitted across the whole document, in render order. Each entry tracks which paragraph and sentence index emitted it.

list_styles_used: Vec<UsedListStyle>

List styles emitted across the whole document, in render order.

Trait Implementations

impl Clone for RenderedDocument

fn clone(&self) -> RenderedDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderedDocument

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

Formats the value using the given formatter.

impl Default for RenderedDocument

fn default() -> RenderedDocument

Returns the “default value” for a type.

impl PartialEq for RenderedDocument

fn eq(&self, other: &RenderedDocument) -> 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 StructuralPartialEq for RenderedDocument