co-storage 0.1.0

COKIT content addressed block storage 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

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

use async_trait::async_trait;
use cid::Cid;
use co_primitives::MappedCid;
use std::collections::BTreeSet;

pub trait StorageContentMapping {
	/// Convert the mapped [`Cid`] to an plain storage [`Cid`].
	fn to_plain(&self, mapped: &Cid) -> Option<Cid>;

	/// Convert the plain storage [`Cid`] to a mapped [`Cid`].
	fn to_mapped(&self, plain: &Cid) -> Option<Cid>;
}

/// Map [`Cid`]s between mappend and plain.
///
/// Plain:
/// - External.
/// - The Cid stored on disk.
/// - For example a Encrypted Block.
///
/// Mapped:
/// - Internal.
/// - The Cid used for references.
/// - Unencrypted.
#[async_trait]
pub trait BlockStorageContentMapping: Send + Sync {
	/// Whether the mapping is active.
	async fn is_content_mapped(&self) -> bool {
		false
	}

	/// Convert the mapped [`Cid`] to an plain storage [`Cid`].
	async fn to_plain(&self, mapped: &Cid) -> Option<Cid> {
		let _mapped = mapped; // prevent warning
		None
	}

	/// Convert the plain storage [`Cid`] to a mapped [`Cid`].
	async fn to_mapped(&self, plain: &Cid) -> Option<Cid> {
		let _plain = plain; // prevent warning
		None
	}

	/// Insert mappings explicitly into storage.
	async fn insert_mappings(&self, mappings: BTreeSet<MappedCid>) {
		let _mappings = mappings; // prevent warning
	}
}