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.

summary: Option<String>

Markdown overview, shown as the sidebar’s leading slide.

rev: Option<String>

Full oid of HEAD at publish time, so anchors resolve against the code they describe after the checkout moves. None resolves against the worktree.

about: ReviewSource

The review this walkthrough describes; its diff is what stops resolve against.

Implementations

impl Walkthrough

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

The note ids of each stop, in stop order. A note is a titleless comment with an anchor_ref inside a stop’s region; it goes to the first stop that holds it.

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