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

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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::fmt::{Debug, Display};
use zeroize::Zeroize;

/// Simple wrapper type for secrents to not escape them.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize, JsonSchema)]
pub struct Secret(
	#[serde(with = "serde_bytes")]
	#[schemars(with = "Vec<u8>")]
	Vec<u8>,
);
impl Secret {
	/// Create secret from vec.
	pub fn new(key: Vec<u8>) -> Self {
		Self(key)
	}

	/// Divulge (access) the secret.
	pub fn divulge(&self) -> &[u8] {
		&self.0
	}
}
impl Display for Secret {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.write_str("*****")
	}
}
impl Debug for Secret {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.debug_struct("Secret").field("secret", &"*****").finish()
	}
}
impl Drop for Secret {
	fn drop(&mut self) {
		self.0.zeroize()
	}
}
impl From<Vec<u8>> for Secret {
	fn from(value: Vec<u8>) -> Self {
		Self(value)
	}
}