co-primitives 0.1.0

COKIT Primitives used throughout the `co-sdk` and `co-api` and Core implementations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 1io BRANDGUARDIAN GmbH

use crate::Tags;
use cid::Cid;
use serde::{Deserialize, Serialize};
use std::collections::BTreeSet;

#[derive(Debug, Serialize, Deserialize)]
pub struct GuardInput {
	/// Gurad name which references this guard in [`co_core_co::Co::guards`].
	pub guard: String,

	/// The state to check the guard against
	pub state: Cid,

	/// The heads that produced the state
	pub heads: BTreeSet<Cid>,

	/// The head to check
	pub next_head: Cid,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GuardOutput {
	/// Gurad result.
	pub result: bool,

	/// Error if the guard has failed.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub error: Option<String>,

	/// Guard Metadata
	#[serde(default, skip_serializing_if = "Tags::is_empty")]
	pub tags: Tags,
}