Struct Frontmatter 

pub struct Frontmatter {
    pub session: Option<String>,
    pub resume: Option<String>,
    pub agent: Option<String>,
    pub model: Option<String>,
    pub branch: Option<String>,
    pub tmux_session: Option<String>,
    pub mode: Option<String>,
    pub format: Option<AgentDocFormat>,
    pub write_mode: Option<AgentDocWrite>,
    pub stream_config: Option<StreamConfig>,
    pub claude_args: Option<String>,
}

Fields

session: Option<String>

Document/routing UUID — permanent identifier for tmux pane routing. Serialized as agent_doc_session in YAML; reads legacy session via alias.

resume: Option<String>

Agent conversation ID — used for --resume with agent backends. Separate from session so the routing key never changes.

agent: Option<String>

model: Option<String>

branch: Option<String>

tmux_session: Option<String>

Tmux session name for pane affinity (e.g., “claude”). Set by claim or sync on first use; used to keep panes in the same session.

mode: Option<String>

Deprecated. Use agent_doc_format + agent_doc_write instead. Kept for backward compatibility. Values: “append”, “template”, “stream”. Serialized as agent_doc_mode in YAML; reads legacy response_mode and shorthand mode via aliases.

format: Option<AgentDocFormat>

Document format: controls document structure (append | template).

write_mode: Option<AgentDocWrite>

Write strategy: controls merge behavior (merge | crdt).

stream_config: Option<StreamConfig>

Stream mode configuration (used when write strategy is CRDT).

claude_args: Option<String>

Additional CLI arguments to pass to the claude process. Space-separated string (e.g., “–dangerously-skip-permissions”).

Implementations

impl Frontmatter

pub fn resolve_mode(&self) -> ResolvedMode

Resolve the canonical (format, write) pair from all three fields.

Priority:

1. Explicit agent_doc_format / agent_doc_write fields (highest)
2. Deprecated agent_doc_mode field (auto-migrated)
3. Defaults: format=template, write=crdt

Trait Implementations

impl Debug for Frontmatter

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

Formats the value using the given formatter.

impl Default for Frontmatter

fn default() -> Frontmatter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Frontmatter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Frontmatter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.