loonfs-core 0.2.0

Core LoonFS engine: namespace metadata, commits, replay, and maintenance.
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Manifest load errors, classified as corruption versus store trouble.

use loonfs_api::wire::manifest::MetadataTableFamily;
use loonfs_api::{ManifestId, ManifestObjectId, NamespaceId};
use serde::{Deserialize, Serialize};
use thiserror::Error;

/// Coarse failure class of a manifest load: corruption versus store trouble.
///
/// Deliberately not named `*ErrorKind` to avoid colliding with the wire-level
/// caller-action concept in [`loonfs_api::ErrorKind`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ManifestLoadFailureClass {
    Corrupt,
    Store,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Error)]
pub enum ManifestLoadError {
    #[error("missing namespace manifest `{object_key}`")]
    MissingManifest { object_key: String },
    #[error("failed to read namespace manifest `{object_key}`: {message}")]
    ReadManifest { object_key: String, message: String },
    #[error("namespace manifest codec error for `{object_key}`: {message}")]
    ManifestCodec { object_key: String, message: String },
    #[error(
        "namespace manifest namespace mismatch for `{object_key}`: expected `{expected}`, actual `{actual}`"
    )]
    ManifestNamespaceMismatch {
        object_key: String,
        expected: NamespaceId,
        actual: NamespaceId,
    },
    #[error(
        "namespace manifest id mismatch for `{object_key}`: expected `{expected}`, actual `{actual}`"
    )]
    ManifestIdMismatch {
        object_key: String,
        expected: ManifestId,
        actual: ManifestId,
    },
    #[error(
        "namespace manifest object id mismatch for `{object_key}`: expected `{expected}`, actual `{actual}`"
    )]
    ManifestObjectIdMismatch {
        object_key: String,
        expected: ManifestObjectId,
        actual: ManifestObjectId,
    },
    #[error(
        "namespace manifest conflict for `{object_key}` manifest `{manifest_id}`: expected payload checksum `{expected_payload_checksum}`, actual `{actual_payload_checksum}`"
    )]
    ManifestConflict {
        object_key: String,
        manifest_id: ManifestId,
        expected_payload_checksum: String,
        actual_payload_checksum: String,
    },
    #[error("namespace manifest `{object_key}` is missing table family `{family:?}`")]
    MissingTableFamily {
        object_key: String,
        family: MetadataTableFamily,
    },
    #[error("namespace manifest `{object_key}` repeats table family `{family:?}`")]
    DuplicateTableFamily {
        object_key: String,
        family: MetadataTableFamily,
    },
    #[error("namespace manifest `{object_key}` has invalid runs: {message}")]
    RunManifestMismatch { object_key: String, message: String },
    #[error("missing metadata SST `{object_key}`")]
    MissingSegment { object_key: String },
    #[error("failed to read metadata SST `{object_key}`: {message}")]
    ReadSegment { object_key: String, message: String },
    #[error("metadata SST codec error for `{object_key}`: {message}")]
    SegmentCodec { object_key: String, message: String },
    #[error("metadata SST key mismatch for `{object_key}`: expected `{expected}`")]
    SegmentObjectKeyMismatch {
        object_key: String,
        expected: String,
    },
    #[error("metadata SST descriptor mismatch for `{object_key}`: {message}")]
    SegmentDescriptorMismatch { object_key: String, message: String },
    #[error(
        "metadata row kind mismatch for `{object_key}` family `{family:?}`: found `{row_kind}`"
    )]
    TableRowKindMismatch {
        object_key: String,
        family: MetadataTableFamily,
        row_kind: String,
    },
    #[error(
        "namespace manifest `{object_key}` has duplicate revision rows in `{family:?}` for key `{row_key}`"
    )]
    DuplicateRevisionRow {
        object_key: String,
        family: MetadataTableFamily,
        row_key: String,
    },
    #[error("namespace manifest `{object_key}` revision index does not match canonical revisions")]
    RevisionIndexMismatch { object_key: String },
}

impl ManifestLoadError {
    pub fn failure_class(&self) -> ManifestLoadFailureClass {
        match self {
            Self::ReadManifest { .. }
            | Self::ReadSegment { .. }
            | Self::ManifestConflict { .. } => ManifestLoadFailureClass::Store,
            _ => ManifestLoadFailureClass::Corrupt,
        }
    }
}