Struct Summary 

pub struct Summary(pub Vec<Segment>);

A structured, render-ready one-line summary: an ordered list of typed Segments.

Rule packs build it; renderers format each segment by its type. This replaces free-text summaries so that number and path formatting is a render-time decision the renderer makes from typed values, rather than a fragile reparse of prose. A producer that owns a concept (a rename detector) owns the wording — it emits the connective Text and the Paths — while the renderer owns the typography. See ADR 2026-06-03-structured-summary-segments.

The ergonomic shortcut for the common case is impl Into<Summary>: with_summary("plain text") still works and produces a single Segment::Text.

Tuple Fields

0: Vec<Segment>

Implementations

impl Summary

pub fn new() -> Self

pub fn text(self, value: impl Into<String>) -> Self

Append verbatim text, coalescing into a trailing text segment if the summary already ends in one. Keeps the serialized form canonical so that helpers like Summary::count which emit a count followed by text don’t leave redundant adjacent text segments on the wire.

pub fn uint(self, value: u64) -> Self

Append a non-negative count (renderer applies digit grouping).

pub fn count(self, n: u64, noun: &str) -> Self

Append a counted noun: "{n} {noun}", with the count as a Segment::Uint (grouped by the renderer) and the noun pluralized with a trailing s unless n == 1. For irregular plurals, build the segments by hand. Example: .count(5, "row") -> 5 rows.

pub fn float(self, value: f64) -> Self

Append a real-valued quantity (renderer applies decimal policy).

pub fn path(self, value: impl Into<String>, snapshot: Side) -> Self

Append a path/locator that resolves in snapshot.

pub fn push(&mut self, segment: Segment)

Append a single segment.

pub fn extend(&mut self, other: Summary)

Append all segments of another summary (e.g. when joining child summaries into a trailer).

pub fn is_empty(&self) -> bool

pub fn segments(&self) -> &[Segment]

pub fn plain_text(&self) -> String

Plain-text rendering with no formatting policy applied: text and path values verbatim, numbers in bare decimal form. For consumers without a renderer (Python bindings, machine sinks, provenance) and for internal bookkeeping such as path-statement detection.

pub fn capitalize_first(self) -> Self

Uppercase the first character of the leading text segment, if the summary begins with text. No-op when it begins with a number or path. Mirrors sentence-casing of prose without scanning a built string.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Summary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Summary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Summary

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

Formats the value using the given formatter.

impl From<&str> for Summary

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Summary

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Segment>> for Summary

fn from(value: Vec<Segment>) -> Self

Converts to this type from the input type.

impl PartialEq for Summary

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

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 Summary