qubit-codec 0.8.0

Core codec traits and buffer conversion primitives for Rust
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Result type for converter steps that may stop with public progress.

use super::super::transcode_progress::TranscodeProgress;
use super::convert_error_of::ConvertErrorOf;

/// Result type for converter steps that may stop with public progress.
///
/// # Type Parameters
///
/// - `D`: Source codec.
/// - `E`: Target codec.
/// - `H`: Converter hook set.
///
/// # Returns
///
/// Returns:
/// - `Ok(Some(progress))` when the converter should propagate public progress,
/// - `Ok(None)` when the current call can continue,
/// - `Err(...)` when an error halts conversion.
pub(in crate::transcode) type ConvertStepResult<D, E, H> =
    Result<Option<TranscodeProgress>, ConvertErrorOf<D, E, H>>;