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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
use super::metric_snapshot_formatter::MetricSnapshotFormatter;
use crate::model::ProgressMetricSnapshot;

/// Formats metric snapshots as compact JSON strings.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub struct JsonMetricSnapshotFormatter;

impl JsonMetricSnapshotFormatter {
    /// Creates a JSON metric snapshot formatter.
    ///
    /// # Returns
    ///
    /// A formatter that serializes each snapshot as one compact JSON string.
    #[inline]
    pub const fn new() -> Self {
        Self
    }
}

impl MetricSnapshotFormatter for JsonMetricSnapshotFormatter {
    /// Formats one metric snapshot as compact JSON.
    ///
    /// # Parameters
    ///
    /// * `snapshot` - Snapshot to serialize.
    ///
    /// # Returns
    ///
    /// A JSON string representing `snapshot`.
    ///
    /// # Panics
    ///
    /// Panics if serde serialization unexpectedly fails.
    #[inline]
    fn format(&self, snapshot: &ProgressMetricSnapshot) -> String {
        serde_json::to_string(snapshot).expect("progress metric snapshot should serialize")
    }
}