qubit-progress 0.2.1

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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
use std::fmt;

/// Lifecycle phase of a progress-producing operation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ProgressPhase {
    /// The operation has started.
    Started,
    /// The operation is still running.
    Running,
    /// The operation finished successfully.
    Finished,
    /// The operation reached a failed terminal state.
    Failed,
    /// The operation was canceled before normal completion.
    Canceled,
}

impl ProgressPhase {
    /// Returns the stable lowercase name of this phase.
    ///
    /// # Returns
    ///
    /// A static string suitable for logs and human-readable reporter output.
    #[inline]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Started => "started",
            Self::Running => "running",
            Self::Finished => "finished",
            Self::Failed => "failed",
            Self::Canceled => "canceled",
        }
    }
}

impl fmt::Display for ProgressPhase {
    /// Formats this phase as its stable lowercase name.
    ///
    /// # Parameters
    ///
    /// * `formatter` - Formatter receiving the phase text.
    ///
    /// # Returns
    ///
    /// The formatter result.
    #[inline]
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}