//! Error types for the vanguards subsystem.

use std::sync::Arc;

use futures::task::SpawnError;

use tor_error::{ErrorKind, HasKind};

use crate::vanguards::{Layer, VanguardMode};

/// An error coming from the vanguards subsystem.

#[derive(Clone, Debug, thiserror::Error)]

#[non_exhaustive]

pub enum VanguardMgrError {

    /// Attempted to use an unbootstrapped `VanguardMgr` for something that

    /// requires bootstrapping to have completed.

    #[error("Cannot {action} with unbootstrapped vanguard manager")]

    BootstrapRequired {

        /// What we were trying to do that required bootstrapping.

        action: &'static str,

    },

    /// Attempted to select a vanguard layer that is not supported in the current [`VanguardMode`],

    #[error("{layer} vanguards are not supported in {mode} mode")]

    LayerNotSupported {

        /// The layer we tried to select a vanguard for.

        layer: Layer,

        /// The [`VanguardMode`] we are in.

        mode: VanguardMode,

    },

    /// Could not find a suitable relay to use for the specifier layer.

    #[error("No suitable relays")]

    NoSuitableRelay(Layer),

    /// Could not get timely network directory.

    #[error("Unable to get timely network directory")]

    NetDir(#[from] tor_netdir::Error),

    /// Failed to access persistent storage.

    #[error("Failed to access persistent vanguard state")]

    State(#[from] tor_persist::Error),

    /// Could not spawn a task.

    #[error("Unable to spawn a task")]

    Spawn(#[source] Arc<SpawnError>),

    /// An internal error occurred.

    #[error("Internal error")]

    Bug(#[from] tor_error::Bug),

}

impl HasKind for VanguardMgrError {

        }

}