Struct Walkthrough 

pub struct Walkthrough {
    pub id: String,
    pub title: String,
    pub author: String,
    pub at: u64,
    pub stops: Vec<String>,
    pub skipped: Option<String>,
    pub summary: Option<String>,
    pub rev: Option<String>,
    pub about: ReviewSource,
}

Fields

id: String

title: String

author: String

at: u64

stops: Vec<String>

The comment ids of the stops, in reading order.

skipped: Option<String>

One line on what the agent left out and why. Surfaced, never hidden.

summary: Option<String>

The walkthrough’s own overview: a markdown body exactly like a stop’s, shown as the sidebar’s leading slide. None for a walkthrough with no summary, which leaves the sidebar starting at the first stop.

rev: Option<String>

The full oid of HEAD when this walkthrough was published, so its anchors can be resolved against the code they actually describe once the checkout moves on. None for a walkthrough saved before this existed; its anchors resolve against the live worktree.

about: ReviewSource

The review this walkthrough describes: the working tree, or the commit/range/PR the human had open when it was published. Its diff is what a stop’s anchor resolves against and what opening the walkthrough renders. Defaults to the working tree for a walkthrough saved before this existed, and for a publish with no other review open.

Implementations

impl Walkthrough

pub fn notes_by_stop(&self, comments: &[Comment]) -> Vec<Vec<String>>

The notes of each stop, in stop order: every comment of the walkthrough’s own session that names no title (so it is a note, not a stop), carries an anchor of its own (a human comment never does), and whose own anchor falls inside that stop’s region. A note whose region matches more than one stop goes to the first, the way the agent wrote it; one matching none (a stop and its own anchor both absent) is not grouped, though it still exists as a comment.

Trait Implementations

impl Clone for Walkthrough

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 Walkthrough

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Walkthrough

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Walkthrough

impl PartialEq for Walkthrough

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Walkthrough

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 Walkthrough