qubit-progress 0.8.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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Reporter trait for complete immutable events.

use crate::{
    Event,
    ReporterError,
};

/// Consumes complete immutable progress events.
pub trait Reporter: Send + Sync {
    /// Returns whether a new operation should emit events.
    ///
    /// [`crate::ProgressBuilder::start`] samples this once per operation.
    fn is_enabled(&self) -> bool {
        true
    }

    /// Delivers one complete event.
    ///
    /// Returns [`ReporterError`] without discarding the sink's error source.
    fn report(&self, event: &Event) -> Result<(), ReporterError>;
}

impl<F> Reporter for F
where
    F: Fn(&Event) -> Result<(), ReporterError> + Send + Sync,
{
    /// Invokes this closure for one complete event.
    fn report(&self, event: &Event) -> Result<(), ReporterError> {
        self(event)
    }
}