Struct Sentence 

pub struct Sentence { /* private fields */ }

Builder for constructing sentences programmatically.

The verb is specified either by a simple tense (via .verb(word, Tense)) or a full verb form (via .form(VerbForm)). The latter unlocks richer constructions like “has been renamed” (present perfect passive) or “is being renamed” (present progressive passive).

Implementations

impl Sentence

pub fn new() -> Self

pub fn subject(self, subject: Subject) -> Self

Set the subject of the sentence.

pub fn verb(self, verb: &str, tense: Tense) -> Self

Set the verb and its simple tense (Past / Present / Future). Implies Aspect::Simple and Mood::Indicative. For richer forms use Sentence::form.

pub fn form(self, form: VerbForm) -> Self

Set the verb form (tense × aspect × mood) directly. Pair with a verb set via Sentence::verb_word or a prior Sentence::verb.

pub fn verb_word(self, verb: &str) -> Self

Set just the verb word, leaving the existing form in place. Useful when form(…) was used and a base verb is set separately.

pub fn voice(self, voice: Voice) -> Self

Set the voice (default: Passive).

• Voice::Passive: “The class Foo was renamed to Foobar”
• Voice::Active: “The class Foo renamed Foobar”

pub fn person(self, person: Person) -> Self

Set the grammatical person used to conjugate auxiliaries (default: Third).

pub fn preposition(self, prep: &str) -> Self

Set the preposition connecting the verb to the object (default: “to” for passive).

e.g., .preposition("into") → “was converted into Bar”

pub fn object(self, object: &str) -> Self

Set the direct object.

pub fn clause(self, clause: Clause) -> Self

Append a subordinate clause.

pub fn render(&self, engine: &Engine) -> Result<String, ProsaicError>

Render the sentence using the given engine’s language.

Trait Implementations

impl Clone for Sentence

fn clone(&self) -> Sentence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sentence

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

Formats the value using the given formatter.

impl Default for Sentence

fn default() -> Self

Returns the “default value” for a type.