Struct AgentDocPipeline 

pub struct AgentDocPipeline {
    pub turn_id: Option<String>,
    pub run_id: Option<String>,
    pub step: Option<String>,
    pub queue_task_id: Option<String>,
}

Live finalize-pipeline state tracker (#fm-run-id-step, Phase 5 of tasks/agent-doc/plans/reentrant-finalize-pipeline.md).

Surfaces the current cycle’s identity and step directly in frontmatter so any agent-doc invocation — or an editor plugin / JB Run Agent Doc action — can read where a crashed or resumed cycle left off without replaying the git log or parsing .agent-doc/cycle_state.

This is ephemeral runtime state, not user configuration: the orchestration layer writes it at each phase transition and clears it once the cycle reaches a terminal phase. step is a free-form string (the orchestration CyclePhase rendered lowercase, e.g. preflight_started / response_captured / write_applied / committed) so an older core build round-trips a newer phase name without data loss, and so agent-doc-core need not depend on the orchestration CyclePhase enum.

Fields

turn_id: Option<String>

Logical turn identifier — the backlog/queue task ID driving this cycle (e.g. #fm-run-id-step), or an auto-generated id when the queue prompt has no backlog match.

run_id: Option<String>

Cycle-state run identifier (the cycle-<millis> capture/cycle id) for correlating frontmatter state with .agent-doc/captures + cycle_state.

step: Option<String>

Current pipeline step — the orchestration CyclePhase rendered as a lowercase string. Free-form so a newer phase round-trips through an older core build.

queue_task_id: Option<String>

Backlog ID for the queued task, when the driving queue prompt resolved to (or created) a tracked backlog item. Distinct from turn_id only when the turn id is auto-generated.

Implementations

impl AgentDocPipeline

pub fn is_empty(&self) -> bool

True when no field is populated. Used by skip_serializing_if so a drained or terminal cycle leaves no agent_doc_pipeline: block behind in the document.

Trait Implementations

impl Clone for AgentDocPipeline

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 AgentDocPipeline

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

Formats the value using the given formatter.

impl Default for AgentDocPipeline

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentDocPipeline

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AgentDocPipeline

impl PartialEq for AgentDocPipeline

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AgentDocPipeline

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 AgentDocPipeline