Struct Session 

pub struct Session { /* private fields */ }

Mutable state for a render sequence. See module docs.

Implementations

impl Session

pub fn new() -> Self

pub fn reset(&mut self)

Clear all session state. Equivalent to replacing with Session::new() but preserves allocations. Use when starting a fully unrelated narrative in the same session — most multi-paragraph callers want Session::reset_for_paragraph instead so style rotation continues.

NOTE: last_temporal_anchor survives so narratives can span paragraphs. Call Session::reset_temporal to clear the anchor explicitly when starting a temporally-disjoint narrative in the same session.

pub fn reset_for_paragraph(&mut self)

Reset paragraph-local discourse while keeping narrative-level style continuity. Pronoun, focus, and Centering Theory state are cleared so anaphora cannot leak across the paragraph break, but every form of stylistic anti-repeat — list-style rotation, template-variant history, connective history, word-repetition scoring, and Round-Robin variant counters — survives, along with the temporal anchor. Consecutive paragraphs therefore rotate through |join phrasings, avoid replaying the same template variant or connective, are penalized for repeating recent vocabulary, and continue to support inter-paragraph temporal references.

This is the reset crate::DocumentPlan::render uses between paragraphs. Library consumers driving their own paragraph loop should prefer this over Session::reset.

pub fn reset_temporal(&mut self)

Clear the temporal anchor. Use when starting a temporally-disjoint narrative in the same session.

pub fn reset_list_cycle(&mut self)

Clear the discourse list-style cycle counter so the next |join pipe starts at the first style in the rotation. Use when starting a stylistically-disjoint narrative in the same session without doing a full Session::reset.

pub fn discourse_mut(&mut self) -> &mut DiscourseState

Mutable access to the underlying discourse state. Use this to call DiscourseState::mention_entity_ranked for templates where grammatical role matters, or to read centering diagnostics such as DiscourseState::cb, DiscourseState::cf, and DiscourseState::last_transition.

pub fn discourse(&self) -> &DiscourseState

Read-only access to the underlying discourse state.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Self

Deep clone. The RoundRobin counters are cloned by reading each atomic with Ordering::Relaxed — fine because clones are used as snapshot/restore checkpoints around fallible renders and there is no concurrent writer during a clone.

last_temporal_anchor is copied so snapshot/restore checkpoints preserve the temporal state correctly.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.