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

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

use crate::StorageError;
use async_trait::async_trait;
use cid::Cid;

/// Storage Pin API.
#[async_trait(?Send)]
pub trait PinApi {
	/// Create new pin.
	async fn add(&mut self, cid: &Cid, options: PinOptions) -> Result<(), StorageError>;

	/// Remove pin.
	async fn remove(&mut self, cid: &Cid) -> Result<(), StorageError>;

	/// Returns whether the CID is pinned.
	async fn is_pinned(&self, cid: &Cid) -> Option<PinKind>;

	/// List all pins.
	async fn iter(&self) -> Box<dyn Iterator<Item = (Cid, PinKind)>>;
}

#[derive(Debug, Default, Clone)]
pub struct PinOptions {
	pub kind: PinKind,
}

#[derive(Debug, Default, Clone)]
pub enum PinKind {
	/// Recursively PIN.
	/// Supported types:
	/// - dag-cbor
	/// - dag-json
	/// - dag-pb
	#[default]
	Recursive,

	/// Directly pinned.
	Direct,

	/// Indirectly pinned (through an recursive direct pin).
	Indirect,
}