graft-core 0.1.1

Core components and types for the Graft storage engine.
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

//! Prefixes are used to distinguish between different types of Graft IDs.
//! The first bit is always set. This ensures that serialized graft IDs serialize to 22 bytes.
//! The next 2 bits currently determine the variant.
//! The rest of the Prefix is reserved for future use.

// We group bytes by field in this file to make it easier to see the bit layout.
#![allow(clippy::unusual_byte_groupings)]

use static_assertions::const_assert_ne;
use std::hash::Hash;
use zerocopy::{ByteHash, Immutable, IntoBytes, KnownLayout, TryFromBytes, Unaligned};

#[derive(
    Clone,
    Copy,
    PartialEq,
    Eq,
    ByteHash,
    PartialOrd,
    Ord,
    IntoBytes,
    Unaligned,
    TryFromBytes,
    Immutable,
    KnownLayout,
    Default,
)]
#[repr(u8)]
pub enum Volume {
    #[default]
    Value = 0b1_00_00000,
}

#[derive(
    Clone,
    Copy,
    PartialEq,
    Eq,
    ByteHash,
    PartialOrd,
    Ord,
    IntoBytes,
    Unaligned,
    TryFromBytes,
    Immutable,
    KnownLayout,
    Default,
)]
#[repr(u8)]
pub enum Segment {
    #[default]
    Value = 0b1_01_00000,
}

#[derive(
    Clone,
    Copy,
    PartialEq,
    Eq,
    ByteHash,
    PartialOrd,
    Ord,
    IntoBytes,
    Unaligned,
    TryFromBytes,
    Immutable,
    KnownLayout,
    Default,
)]
#[repr(u8)]
pub enum Client {
    #[default]
    Value = 0b1_10_00000,
}

const_assert_ne!(Volume::Value as u8, Segment::Value as u8);
const_assert_ne!(Volume::Value as u8, Client::Value as u8);
const_assert_ne!(Segment::Value as u8, Client::Value as u8);

pub trait Prefix:
    Clone
    + PartialEq
    + Eq
    + PartialOrd
    + Ord
    + Hash
    + IntoBytes
    + TryFromBytes
    + Immutable
    + KnownLayout
    + Default
    + Unaligned
{
}

impl Prefix for Volume {}
impl Prefix for Segment {}
impl Prefix for Client {}