vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: use rustdoc comments for manager-only variant markers

Browse source
This commit is contained in:
damocles 2026-06-01 09:34:33 +02:00 • committed by mara
commit 4263fd25f5
1 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

36
hive-sh4re/src/lib.rs
View file

@ -296,8 +296,8 @@ pub enum CancelLooseEndKind {
} }
/// Unified request enum for both agent and manager sockets. The agent's /// Unified request enum for both agent and manager sockets. The agent's
/// identity is the socket it arrived on. Manager-only variants are tagged /// identity is the socket it arrived on. Manager-only variants are marked
/// `// privileged` — an agent socket returns `Err` for them server-side. /// `*(manager only)*` — an agent socket returns `Err` for them server-side.
/// ///
/// `AgentRequest` and `ManagerRequest` are type aliases for this enum; /// `AgentRequest` and `ManagerRequest` are type aliases for this enum;
/// existing callers continue to compile unchanged. /// existing callers continue to compile unchanged.
@ -428,57 +428,57 @@ pub enum Request {
/// `docs/conventions.md::Broker delivery + ack cycle`. /// `docs/conventions.md::Broker delivery + ack cycle`.
RequeueInflight, RequeueInflight,
// ---- privileged: manager socket only ----------------------------------- // ---- manager socket only ------------------------------------------------
/// Initialise a brand-new agent's proposed config repo and queue an /// *(manager only)* Initialise a brand-new agent's proposed config repo
/// approval for the operator to review. // privileged /// and queue an approval for the operator to review.
RequestInitConfig { RequestInitConfig {
name: String, name: String,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
description: Option<String>, description: Option<String>,
}, },
/// Stop a sub-agent (graceful). // privileged /// *(manager only)* Stop a sub-agent (graceful).
Kill { name: String }, Kill { name: String },
/// Start a previously-stopped sub-agent container. // privileged /// *(manager only)* Start a previously-stopped sub-agent container.
Start { name: String }, Start { name: String },
/// Restart a sub-agent container (stop + start). // privileged /// *(manager only)* Restart a sub-agent container (stop + start).
Restart { name: String }, Restart { name: String },
/// Rebuild a sub-agent against the current hyperhive flake + agent.nix. /// *(manager only)* Rebuild a sub-agent against the current hyperhive
/// No approval required. // privileged /// flake + agent.nix. No approval required.
Update { name: String }, Update { name: String },
/// Submit a config commit for the operator to approve. // privileged /// *(manager only)* Submit a config commit for the operator to approve.
RequestApplyCommit { RequestApplyCommit {
agent: String, agent: String,
commit_ref: String, commit_ref: String,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
description: Option<String>, description: Option<String>,
}, },
/// Fetch recent journal lines for a sub-agent container. // privileged /// *(manager only)* Fetch recent journal lines for a sub-agent container.
GetLogs { GetLogs {
agent: String, agent: String,
#[serde(default)] #[serde(default)]
lines: Option<u32>, lines: Option<u32>,
}, },
/// Queue an approval to run `nix flake update [inputs...]`. // privileged /// *(manager only)* Queue an approval to run `nix flake update [inputs...]`.
RequestUpdateMetaInputs { RequestUpdateMetaInputs {
#[serde(default)] #[serde(default)]
inputs: Vec<String>, inputs: Vec<String>,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
description: Option<String>, description: Option<String>,
}, },
/// Queue an approval to add a scheduled prompt. // privileged /// *(manager only)* Queue an approval to add a scheduled prompt.
RequestSchedulePrompt(SchedulePromptPayload), RequestSchedulePrompt(SchedulePromptPayload),
/// Cancel a scheduled prompt. // privileged /// *(manager only)* Cancel a scheduled prompt.
CancelSchedule { CancelSchedule {
id: i64, id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]
targets: Option<Vec<String>>, targets: Option<Vec<String>>,
}, },
/// List every schedule in the queue. // privileged /// *(manager only)* List every schedule in the queue.
ListSchedules, ListSchedules,
/// Fire a scheduled prompt out of band immediately. // privileged /// *(manager only)* Fire a scheduled prompt out of band immediately.
FireScheduleNow { id: i64 }, FireScheduleNow { id: i64 },
/// Edit an existing schedule's mutable fields. // privileged /// *(manager only)* Edit an existing schedule's mutable fields.
EditSchedule { EditSchedule {
id: i64, id: i64,
#[serde(default, skip_serializing_if = "Option::is_none")] #[serde(default, skip_serializing_if = "Option::is_none")]