calliper 0.1.4

Fine-grained benchmarking made easy.
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

use thiserror::Error;

use crate::utils;

/// An error that occured during benchmark harness.
#[non_exhaustive]
#[derive(Debug, Error)]
pub enum CalliperError {
    /// ID of a spawned Calliper subprocess was out-of-bounds. This should not happen under normal
    /// circumstances, unless Calliper environment variable is somehow overwritten.
    #[error("Internal error: run ID is out of bounds (limit: {limit}, value: {value})")]
    RunIdOutOfBounds {
        /// Maximum permitted run ID value.
        limit: usize,
        /// Actual run ID value.
        value: usize,
    },
    /// ID of a spawned Calliper subprocess is not an integer. This should not happen under normal
    /// circumstances, unless Calliper environment variable is somehow overwritten.
    #[error("Internal error: run ID is malformed. Please report this to Calliper bug tracker")]
    RunIdError(#[from] utils::RunIdError),
    /// Generic benchmark error. Insufficient privileges are one of the most common causes.
    #[error("Benchmark failure: {reason}")]
    BenchmarkFailure {
        #[from]
        /// Reason of failure.
        reason: Box<dyn std::error::Error>,
    },
}