qubit-progress 0.8.3

Generic progress reporting abstractions for Qubit Rust libraries
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Errors encountered while starting a progress operation.
// qubit-style: allow source-test-pair

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

use crate::error::ConfigurationError;
use crate::error::DeliveryError;
use crate::error::EmissionError;

/// Failure before a usable progress operation can be returned.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum StartError {
    /// Fixed operation metadata is invalid.
    InvalidConfiguration(ConfigurationError),
    /// The process-local operation ID space is exhausted.
    OperationIdExhausted,
    /// Started was attempted but rejected by the reporter.
    Delivery(DeliveryError),
}

impl fmt::Display for StartError {
    /// Formats the start failure.
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidConfiguration(error) => error.fmt(formatter),
            Self::OperationIdExhausted => {
                formatter.write_str("progress operation IDs are exhausted")
            }
            Self::Delivery(error) => error.fmt(formatter),
        }
    }
}

impl Error for StartError {
    /// Returns the nested configuration or delivery failure.
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::InvalidConfiguration(error) => Some(error),
            Self::OperationIdExhausted => None,
            Self::Delivery(error) => Some(error),
        }
    }
}

impl From<ConfigurationError> for StartError {
    /// Converts configuration validation into a start failure.
    fn from(error: ConfigurationError) -> Self {
        Self::InvalidConfiguration(error)
    }
}

impl From<EmissionError> for StartError {
    /// Converts the only possible start-time emission failures.
    fn from(error: EmissionError) -> Self {
        match error {
            EmissionError::Delivery(error) => Self::Delivery(error),
            EmissionError::SequenceExhausted => Self::OperationIdExhausted,
        }
    }
}