qubit-retry 0.9.2

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/
//! Attempt executor failure information.
//!
//! Author: Haixing Hu

use std::error::Error;
use std::fmt;
use std::io;

use serde::{Deserialize, Serialize};

/// Failure produced by the retry executor before an attempt can run normally.
///
/// This type is used for infrastructure failures such as failing to spawn a
/// worker thread for [`crate::Retry::run_in_worker`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttemptExecutorError {
    /// Human-readable executor failure message.
    message: Box<str>,
}

impl AttemptExecutorError {
    /// Creates an executor failure from a message.
    ///
    /// # Parameters
    /// - `message`: Failure message to store.
    ///
    /// # Returns
    /// An executor failure value.
    #[inline]
    pub fn new(message: &str) -> Self {
        Self {
            message: message.into(),
        }
    }

    /// Creates an executor failure from a worker-spawn error.
    ///
    /// # Parameters
    /// - `error`: Error returned by `std::thread::Builder::spawn`.
    ///
    /// # Returns
    /// An executor failure describing the spawn error.
    #[inline]
    #[cfg_attr(coverage, allow(dead_code))]
    pub(crate) fn from_spawn_error(error: io::Error) -> Self {
        Self::new(&format!("failed to spawn retry worker thread: {error}"))
    }

    /// Creates an executor failure for a worker that ended without reporting.
    ///
    /// # Returns
    /// An executor failure describing the missing worker result.
    #[inline]
    pub(crate) fn from_worker_disconnected() -> Self {
        Self::new("retry worker thread stopped without sending a result")
    }

    /// Returns the executor failure message.
    ///
    /// # Returns
    /// Failure message text.
    #[inline]
    pub fn message(&self) -> &str {
        &self.message
    }
}

impl fmt::Display for AttemptExecutorError {
    /// Formats the executor failure message.
    ///
    /// # Parameters
    /// - `f`: Formatter provided by the standard formatting machinery.
    ///
    /// # Returns
    /// Formatting result.
    ///
    /// # Errors
    /// Returns a formatting error if the formatter rejects output.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.message)
    }
}

impl Error for AttemptExecutorError {}