pacifica-rs 1.0.0

rust implementation of PacificA: Replication in Log-Based Distributed Storage Systems
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
114
115
116
117
118

use std::fmt::{Display, Formatter};
use crate::LogId;
use anyerror::AnyError;
use thiserror::Error;

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ErrorVerb {
    Read,
    Write,
    Seek,
    Delete,
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ErrorSubject {
    OpenWriter,
    OpenReader,

    FlushWriter,
    AppendEntries { index: usize },
    TruncatePrefix { first_log_index_kept: usize },
    TruncateSuffix { last_log_index_kept: usize },
    ResetLogStorage { next_log_index: usize },
    GetLogEntry { log_index: usize },
    ReadLogId,
    WriteLogId { log_id: LogId },
    GenerateReaderId,
    DownloadSnapshot { reader_id: usize },
}

#[derive(Debug, Clone, Error, PartialEq, Eq)]
pub struct StorageError {
    subject: ErrorSubject,
    verb: ErrorVerb,
    source: AnyError,
    backtrace: Option<String>,
}

impl StorageError {
    pub fn new(subject: ErrorSubject, verb: ErrorVerb, source: impl Into<AnyError>) -> StorageError {
        Self {
            subject,
            verb,
            source: source.into(),
            backtrace: anyerror::backtrace_str(),
        }
    }

    pub fn open_reader(source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::OpenReader, ErrorVerb::Read, source)
    }

    pub fn get_log_entry(log_index: usize, source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::GetLogEntry { log_index }, ErrorVerb::Read, source)
    }

    pub fn open_writer(source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::OpenWriter, ErrorVerb::Write, source)
    }

    pub fn append_entries(index: usize, source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::AppendEntries { index }, ErrorVerb::Write, source)
    }

    pub fn flush_writer(source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::FlushWriter, ErrorVerb::Write, source)
    }

    pub fn truncate_prefix(first_log_index_kept: usize, source: impl Into<AnyError>) -> Self {
        Self::new(
            ErrorSubject::TruncatePrefix { first_log_index_kept },
            ErrorVerb::Write,
            source,
        )
    }

    pub fn truncate_suffix(last_log_index_kept: usize, source: impl Into<AnyError>) -> Self {
        Self::new(
            ErrorSubject::TruncateSuffix { last_log_index_kept },
            ErrorVerb::Write,
            source,
        )
    }

    pub fn reset(next_log_index: usize, source: impl Into<AnyError>) -> Self {
        Self::new(
            ErrorSubject::ResetLogStorage { next_log_index },
            ErrorVerb::Write,
            source,
        )
    }

    pub fn read_log_id(source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::ReadLogId, ErrorVerb::Read, source)
    }

    pub fn write_log_id(log_id: LogId, source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::WriteLogId { log_id }, ErrorVerb::Write, source)
    }

    pub fn download_snapshot(reader_id: usize, source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::DownloadSnapshot { reader_id }, ErrorVerb::Write, source)
    }

    pub fn generate_reader_id(source: impl Into<AnyError>) -> Self {
        Self::new(ErrorSubject::GenerateReaderId, ErrorVerb::Write, source)
    }
}


impl Display for StorageError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let _ = write!(f, " StorageError: \n");
        let _ = write!(f, "      Subject: {:?} \n", self.subject);
        let _=  write!(f, "         Verb: {:?} \n", self.verb);
        write!(f, "       Source: {}", self.source)
    }
}