qubit-progress 0.5.0

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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
use crate::{
    model::ProgressEvent,
    reporter::{
        JsonWriterProgressReporter,
        ProgressReporter,
    },
};

/// Progress reporter that writes JSON metric snapshots to stderr.
pub struct JsonStderrProgressReporter {
    /// JSON writer-backed reporter targeting standard error.
    inner: JsonWriterProgressReporter<std::io::Stderr>,
}

impl JsonStderrProgressReporter {
    /// Creates a JSON reporter writing to standard error.
    ///
    /// # Returns
    ///
    /// A JSON stderr progress reporter.
    #[inline]
    pub fn new() -> Self {
        Self {
            inner: JsonWriterProgressReporter::from_writer(std::io::stderr()),
        }
    }
}

impl Default for JsonStderrProgressReporter {
    /// Creates a default JSON stderr progress reporter.
    ///
    /// # Returns
    ///
    /// A JSON stderr progress reporter.
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}

impl ProgressReporter for JsonStderrProgressReporter {
    /// Writes one JSON line for every metric snapshot in the event.
    ///
    /// # Parameters
    ///
    /// * `event` - Progress event to report.
    #[inline]
    fn report(&self, event: &ProgressEvent) {
        self.inner.report(event);
    }
}