Struct ProtocolGuidance 

pub struct ProtocolGuidance {

    pub schema: &'static str,
    pub command: &'static str,
    pub status: ProtocolStatus,
    pub snapshot_at: String,
    pub valid_for_sec: u32,
    pub revalidate_cmd: Option<String>,
    pub bone: Option<BoneRef>,
    pub workspace: Option<String>,
    pub review: Option<ReviewRef>,
    pub steps: Vec<String>,
    pub diagnostics: Vec<String>,
    pub advice: Option<String>,
    pub executed: bool,
    pub execution_report: Option<ExecutionReport>,
}

A rendered protocol guidance output.

Provides a snapshot of agent state (bones, workspaces, reviews) with next steps as shell commands agents can execute.

Freshness Semantics:

• snapshot_at: UTC timestamp when this guidance was generated
• valid_for_sec: How long this guidance remains fresh (in seconds)
• revalidate_cmd: If present, run this command to refresh guidance

Agents receiving stale guidance (snapshot_at + valid_for_sec < now) should re-run the revalidate_cmd to get fresh state before executing steps.

Fields

schema: &'static str

Schema version for machine parsing

command: &'static str

Command type: “start”, “finish”, “review”, “cleanup”, “resume”

status: ProtocolStatus

Status indicating readiness or blocker

snapshot_at: String

UTC ISO 8601 snapshot timestamp

valid_for_sec: u32

Validity duration in seconds (how long this guidance is fresh)

revalidate_cmd: Option<String>

Command to re-fetch fresh guidance if stale (e.g., “edict protocol start”)

bone: Option<BoneRef>

Bone context (if applicable)

workspace: Option<String>

Workspace name (if applicable)

review: Option<ReviewRef>

Review context (if applicable)

steps: Vec<String>

Rendered shell commands (ready to copy-paste)

diagnostics: Vec<String>

Diagnostic messages if blocked or errored

advice: Option<String>

Human-readable summary

executed: bool

Whether commands were executed (–execute mode)

execution_report: Option<ExecutionReport>

Execution report (if –execute was used)

Implementations

impl ProtocolGuidance

pub fn new(command: &'static str) -> Self

Create a new guidance with ready status. Default freshness: 300 seconds (5 minutes)

pub fn set_freshness( &mut self, valid_for_sec: u32, revalidate_cmd: Option<String>, )

Set the validity duration and optional revalidate command. Use this to control how long guidance remains fresh.

pub fn step(&mut self, cmd: String)

Add a step command.

pub fn steps(&mut self, cmds: Vec<String>)

Add multiple steps.

pub fn diagnostic(&mut self, msg: String)

Add a diagnostic message (e.g., reason for blocked status).

pub fn blocked(&mut self, reason: String)

Set status and add corresponding diagnostics.

pub fn advise(&mut self, msg: String)

Set advice message (human-readable summary).

Trait Implementations

impl Clone for ProtocolGuidance

fn clone(&self) -> ProtocolGuidance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolGuidance

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

Formats the value using the given formatter.

impl Deserialize<'static> for ProtocolGuidance

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

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProtocolGuidance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.