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

/*
 * Copyright 2018 Bitwise IO, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -----------------------------------------------------------------------------
 */

use std::error::Error;
use std::fmt;

/// An error that may occur on state writes.
#[derive(Debug)]
pub enum StateWriteError {
    /// Attempted to write to state from a given state id, and that state id
    /// does not exist
    InvalidStateId(String),
    /// An error occurred with the underlying storage mechanism
    StorageError(Box<dyn Error>),
}

impl fmt::Display for StateWriteError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            StateWriteError::InvalidStateId(msg) => write!(f, "Invalid State Id: {}", msg),
            StateWriteError::StorageError(err) => write!(f, "Storage Error: {}", err),
        }
    }
}

impl Error for StateWriteError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            StateWriteError::InvalidStateId(_) => None,
            StateWriteError::StorageError(err) => Some(err.as_ref()),
        }
    }
}

/// An error that may occur on state reads.
#[derive(Debug)]
pub enum StateReadError {
    /// Attempted to read to state from a given state id, and that state id
    /// does not exist.
    InvalidStateId(String),
    /// An poorly formed or invalid key was provided.
    InvalidKey(String),
    /// An error occurred with the underlying storage mechanism
    StorageError(Box<dyn Error>),
}

impl fmt::Display for StateReadError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            StateReadError::InvalidStateId(msg) => write!(f, "Invalid State Id: {}", msg),
            StateReadError::InvalidKey(key) => write!(f, "Invalid Key: {}", key),
            StateReadError::StorageError(err) => write!(f, "Storage Error: {}", err),
        }
    }
}

impl Error for StateReadError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            StateReadError::InvalidStateId(_) | StateReadError::InvalidKey(_) => None,
            StateReadError::StorageError(err) => Some(err.as_ref()),
        }
    }
}

/// An error that may occur on a state prune.
#[derive(Debug)]
pub enum StatePruneError {
    /// Attempted to prune a state id that does not exist.
    InvalidStateId(String),
    /// An error occurred with the underlying storage mechanism.
    StorageError(Box<dyn Error>),
}

impl fmt::Display for StatePruneError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            StatePruneError::InvalidStateId(msg) => write!(f, "Invalid State Id: {}", msg),
            StatePruneError::StorageError(err) => write!(f, "Storage Error: {}", err),
        }
    }
}

impl Error for StatePruneError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            StatePruneError::InvalidStateId(_) => None,
            StatePruneError::StorageError(err) => Some(err.as_ref()),
        }
    }
}