libvctrl_handler 3.0.0

Fundamental contracts for building a version control system – no implementations, only traits and types
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

use crate::errors::VctrlError;
use crate::types::{Blob, Commit, Hash, Tag, Tree};

pub trait ObjectStore {
    fn put(&mut self, hash: &Hash, data: &[u8]) -> Result<(), VctrlError>;

    fn get(&self, hash: &Hash) -> Result<Vec<u8>, VctrlError>;

    fn delete(&mut self, hash: &Hash) -> Result<(), VctrlError>;

    fn exists(&self, hash: &Hash) -> Result<bool, VctrlError>;
}

pub trait RefStore {
    fn set_ref(&mut self, name: &str, hash: &Hash) -> Result<(), VctrlError>;

    fn get_ref(&self, name: &str) -> Result<Hash, VctrlError>;

    fn delete_ref(&mut self, name: &str) -> Result<(), VctrlError>;

    fn list_refs(&self) -> Result<Vec<String>, VctrlError>;
}

pub trait Hasher {
    #[must_use]
    fn hash(&self, data: &[u8]) -> Hash;
}

pub trait Encoder {
    fn encode_blob(&self, blob: &Blob) -> Result<Vec<u8>, VctrlError>;

    fn encode_tree(&self, tree: &Tree) -> Result<Vec<u8>, VctrlError>;

    fn encode_commit(&self, commit: &Commit) -> Result<Vec<u8>, VctrlError>;

    fn encode_tag(&self, tag: &Tag) -> Result<Vec<u8>, VctrlError>;
}

pub trait Decoder {
    fn decode_blob(&self, data: &[u8]) -> Result<Blob, VctrlError>;

    fn decode_tree(&self, data: &[u8]) -> Result<Tree, VctrlError>;

    fn decode_commit(&self, data: &[u8]) -> Result<Commit, VctrlError>;

    fn decode_tag(&self, data: &[u8]) -> Result<Tag, VctrlError>;
}

pub trait Signer {
    fn sign(&self, data: &[u8]) -> Result<Vec<u8>, VctrlError>;
}

pub trait Verifier {
    fn verify(&self, data: &[u8], signature: &[u8]) -> Result<bool, VctrlError>;
}

pub trait Transport {
    fn fetch_object(&self, hash: &Hash) -> Result<Vec<u8>, VctrlError>;

    fn push_object(&mut self, hash: &Hash, data: &[u8]) -> Result<(), VctrlError>;
}