use harn_vm::tool_annotations::SideEffectLevel;
use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum Outcome<T> {
Ready(T),
Unavailable(Unavailable),
}
#[derive(Debug, Serialize)]
pub struct Unavailable {
pub available: bool,
pub reason: &'static str,
pub detail: String,
}
pub(super) fn unavailable<T>(reason: &'static str, detail: impl Into<String>) -> Outcome<T> {
Outcome::Unavailable(Unavailable {
available: false,
reason,
detail: detail.into(),
})
}
#[derive(Debug, Serialize)]
pub struct CaptureReceipt {
pub available: bool,
pub boundary_id: String,
pub writer_policy: WriterPolicy,
pub scanned_files: usize,
pub stored_files: usize,
pub stored_bytes: u64,
pub unrestorable_files: usize,
pub scan_errors: usize,
pub scan_ms: u64,
}
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[non_exhaustive]
#[serde(rename_all = "snake_case")]
pub enum WriterPolicy {
LegacyScan,
RequireKnown,
}
#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd, Serialize)]
#[non_exhaustive]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum ChangeWriter {
Unknown,
}
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(tag = "kind", rename_all = "snake_case", deny_unknown_fields)]
pub enum ObservedFileState {
Absent,
Present {
sha256: String,
},
}
#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ConfirmedPath {
pub session_id: String,
pub boundary_id: String,
pub path: String,
pub observed: ObservedFileState,
}
#[derive(Debug, Serialize)]
pub struct CallBeginReceipt {
pub available: bool,
pub call_id: String,
pub scanned_files: usize,
pub scan_errors: usize,
pub scan_ms: u64,
}
#[derive(Clone, Debug, Serialize)]
pub struct AttributedChange {
pub path: String,
pub kind: &'static str,
pub writer: ChangeWriter,
#[serde(skip_serializing_if = "Option::is_none")]
pub post_hash: Option<String>,
#[serde(skip_serializing_if = "std::ops::Not::not")]
pub incomplete: bool,
}
#[derive(Debug, Serialize)]
pub struct CallEndReceipt {
pub available: bool,
pub call_id: String,
pub changes: Vec<AttributedChange>,
pub scan_errors: usize,
#[serde(skip_serializing_if = "Option::is_none")]
pub persistence_error: Option<String>,
}
#[derive(Clone, Debug, Serialize)]
pub struct PlanEntry {
pub path: String,
pub action: &'static str,
pub writers: Vec<ChangeWriter>,
#[serde(skip_serializing_if = "Option::is_none")]
pub observed: Option<ObservedFileState>,
#[serde(skip_serializing_if = "Option::is_none")]
pub reason: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub expected_hash: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub found_hash: Option<String>,
}
#[derive(Clone, Debug, Serialize)]
pub struct IrreversibleEffect {
pub call_id: String,
pub invocation: u64,
pub side_effect: SideEffectLevel,
}
#[derive(Debug, Serialize)]
pub struct PlanReceipt {
pub available: bool,
pub session_id: String,
pub boundary_id: String,
pub entries: Vec<PlanEntry>,
pub irreversible: Vec<IrreversibleEffect>,
}
#[derive(Debug, Serialize)]
pub struct RestoreReceipt {
pub available: bool,
pub boundary_id: String,
pub restored: Vec<PlanEntry>,
pub refused: Vec<PlanEntry>,
pub skipped: Vec<PlanEntry>,
pub failed: Vec<PlanEntry>,
pub irreversible: Vec<IrreversibleEffect>,
#[serde(skip_serializing_if = "Option::is_none")]
pub persistence_error: Option<String>,
}
#[derive(Debug, Serialize)]
pub struct DropReceipt {
pub dropped: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub error: Option<String>,
}