qubit-redact 0.8.1

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Validation errors for truncated HTTP body captures.

use std::error::Error;
use std::fmt;
use std::fmt::Display;
use std::fmt::Formatter;

/// Reports inconsistent source-length metadata for a body capture.
///
/// # Examples
///
/// ```
/// use qubit_redact::formats::http::BodyCapture;
/// use qubit_redact::formats::http::BodyCaptureError;
///
/// let error = BodyCapture::truncated(b"prefix", 3)
///     .expect_err("the claimed total must exceed captured bytes");
/// assert!(matches!(error, BodyCaptureError::InvalidTotalLength { .. }));
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BodyCaptureError {
    /// A truncated capture claimed a total no larger than captured bytes.
    InvalidTotalLength {
        /// Number of bytes present in the capture.
        captured: usize,
        /// Rejected claimed total source length.
        total: usize,
    },
}

impl Display for BodyCaptureError {
    /// Writes a concise description of the invalid capture metadata.
    ///
    /// # Parameters
    ///
    /// * `formatter` - Destination formatting context.
    ///
    /// # Returns
    ///
    /// The formatter result from writing the error description.
    ///
    /// # Errors
    ///
    /// Returns [`fmt::Error`] when the destination rejects a write.
    #[inline]
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidTotalLength { captured, total } => write!(
                formatter,
                "truncated body total length {total} must exceed {captured} captured bytes",
            ),
        }
    }
}

impl Error for BodyCaptureError {}