Struct Report 

pub struct Report {
    pub run: RunId,
    pub agent: AgentName,
    pub itinerary: ItineraryId,
    pub headline: String,
    pub body: String,
    pub artifacts: Vec<String>,
    pub at: Timestamp,
}

What one run concluded.

Fields

run: RunId

The run this describes.

agent: AgentName

Which agent wrote it.

itinerary: ItineraryId

The chain it belonged to.

headline: String

One line, for a list. What happened, not what was attempted.

body: String

The report itself, as the agent wrote it.

artifacts: Vec<String>

What it produced or changed: paths, branch names, pull request identifiers.

Separate from the body so a reader can find the output without reading the prose, and so a later run can be told what an earlier one left behind.

at: Timestamp

When it was written.

Implementations

impl Report

pub fn new( run: RunId, agent: AgentName, itinerary: ItineraryId, headline: impl Into<String>, body: impl Into<String>, at: Timestamp, ) -> Self

Records a report, trimming anything past the caps.

Truncates rather than rejecting. A report is the only account of a run that has already happened and already cost money; throwing it away because it was too long would lose the thing entirely to punish a formatting mistake.

pub fn producing(self, artifacts: Vec<String>) -> Self

Names what the run produced.

pub fn has_body(&self) -> bool

Returns true when the agent had something to say beyond the headline.

pub fn was_trimmed(&self) -> bool

Returns true when anything was trimmed to fit.

Worth surfacing: a reader who can see the report was cut knows to look at the transcript rather than assuming the agent stopped there.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Report

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Report

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Report

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Report