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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

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

use serde::{Deserialize, Serialize};

/// Special CO metadata.
pub trait CoMetadata: Serialize {
	fn metadata() -> Vec<Metadata>;
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Metadata {
	/// External field namess.
	#[serde(rename = "ext")]
	External(Vec<String>),
}

#[derive(Clone, Serialize)]
pub struct WithCoMetadata<T: CoMetadata + Serialize> {
	#[serde(rename = "$co", skip_serializing_if = "Vec::is_empty")]
	co: Vec<Metadata>,
	#[serde(flatten)]
	value: T,
}
impl<T> WithCoMetadata<T>
where
	T: CoMetadata + Serialize,
{
	pub fn new(value: T) -> Self {
		Self { co: T::metadata(), value }
	}
}
impl<T: CoMetadata + Serialize> From<T> for WithCoMetadata<T> {
	fn from(value: T) -> Self {
		WithCoMetadata::new(value)
	}
}

// pub fn serialize_with_metadata<T: CoMetadata + Serialize, S: serde::Serializer>(
// 	serializer: S,
// 	value: T,
// ) -> Result<S::Ok, S::Error> {
// 	WithCoMetadata::new(value).serialize(serializer)
// }

// Workaround for https://github.com/rust-lang/rust/issues/50133
// pub struct WithCoMetadataWrapper<T>(T);
// impl<T: CoMetadata> Into<WithCoMetadataWrapper<T>> for WithCoMetadata<T> {
// 	fn into(self) -> WithCoMetadataWrapper<T> {
// 		WithCoMetadataWrapper(self.value)
// 	}
// }
// impl<T: CoMetadata> Into<WithCoMetadata<T>> for T {
// 	fn into(self) -> WithCoMetadata<T> {
// 		WithCoMetadata::new(self)
// 	}
// }

#[cfg(test)]
mod tests {
	use super::WithCoMetadata;
	use crate::{CoMetadata, Metadata};
	use cid::Cid;
	use co_macros::TaggedFields;
	use serde::{Deserialize, Serialize};

	#[test]
	fn metadata() {
		#[derive(Debug, Clone, Serialize, Deserialize)]
		// error[E0275]: overflow evaluating the requirement `&mut Vec<u8>: Sized`
		// #[serde(into = "WithCoMetadata<Test>")]
		struct Test {
			hello: i32,
			world: Cid,
		}
		impl CoMetadata for Test {
			fn metadata() -> Vec<crate::Metadata> {
				vec![Metadata::External(vec!["world".to_owned()])]
			}
		}
		// impl Serialize for Test {
		// 	fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
		// 	where
		// 		S: serde::Serializer,
		// 	{
		// 		self.serialize_with_metadata(serializer)
		// 	}
		// }

		let json = serde_json::to_string_pretty(&WithCoMetadata::new(Test {
			hello: 1,
			world: Cid::try_from("bafyr4igf663hpuvdpvque42uxmkbacg5ubd4cgageulmwmqo33g2tpod7e").unwrap(),
		}))
		.unwrap();
		println!("{json}");
	}

	#[test]
	fn metadata_derive() {
		#[derive(Debug, Clone, Serialize, Deserialize, TaggedFields)]
		struct Test {
			hello: i32,
			#[tagged(external)]
			world: Cid,
		}
		let json = serde_json::to_string_pretty(&WithCoMetadata::new(Test {
			hello: 1,
			world: Cid::try_from("bafyr4igf663hpuvdpvque42uxmkbacg5ubd4cgageulmwmqo33g2tpod7e").unwrap(),
		}))
		.unwrap();
		println!("{json}");
	}
}

// impl<T> From<WithCoMetadata<T>> for T
// where
// 	T: CoMetadata,
// {
// 	fn from(value: WithCoMetadata<T>) -> Self {
// 		value.value
// 	}
// }

// impl<T: CoMetadata> Into<T> for WithCoMetadata<T> {
// 	fn into(self) -> T {
// 		self.value
// 	}
// }

// #[proc_macro_attribute]
// pub fn co_metadata(attr: TokenStream, input: TokenStream) -> TokenStream {
// }

// macro_rules! metadata_serialize {
// 	($t:ident) => {
// 		impl Serialize for X {
// 			fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
// 				#[derive(Serialize)]
// 				struct XSerialize {
// 					a: u32,
// 					b: u32,
// 					c: u32,
// 					$co: &'static str,
// 				}

// 				XSerialize { a: self.a, b: self.b, c: self.c, d: "only at serialization" }.serialize(serializer)
// 			}
// 		}
// 	};
// }

// impl Serialize for X {
// 	fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
// 		#[derive(Serialize)]
// 		struct XSerialize {
// 			a: u32,
// 			b: u32,
// 			c: u32,
// 			d: &'static str,
// 		}

// 		XSerialize { a: self.a, b: self.b, c: self.c, d: "only at serialization" }.serialize(serializer)
// 	}
// }