Enum BackendError 

pub enum BackendError {
    BackendNotAvailable {
        requested: String,
        available: Vec<String>,
    },
    InvalidBackend {
        requested: String,
        available: Vec<String>,
    },
    InitializationFailed {
        backend: String,
        source: Box<dyn Error + Send + Sync>,
    },
    MissingConfiguration {
        backend: String,
        missing_vars: Vec<String>,
    },
}

Errors that can occur during backend selection and initialization.

This type is returned by the factory function create_communicator when the requested backend cannot be selected or initialized.

Variants

BackendNotAvailable

The requested backend is not compiled into this binary.

The user or environment requested a backend that was not enabled via Cargo feature flags at compile time.

Fields

requested: String

The backend name that was requested (e.g., "mpi").

available: Vec<String>

List of backend names that are compiled into this binary.

InvalidBackend

The requested backend name is not recognized.

The value set in COBRE_COMM_BACKEND does not match any known backend name.

Fields

requested: String

The unrecognized backend name that was requested.

available: Vec<String>

List of all known backend names (compiled in or not).

InitializationFailed

The backend initialization failed.

The backend was correctly selected but failed to initialize, for example because the MPI runtime is not installed, the TCP coordinator is unreachable, or the shared memory segment does not exist.

Fields

backend: String

Name of the backend that failed to initialize (e.g., "mpi").

source: Box<dyn Error + Send + Sync>

The underlying error from the backend initialization.

MissingConfiguration

Required environment variables for the selected backend are not set.

The TCP and shared memory backends require additional configuration via environment variables. This error lists the variables that are missing.

Fields

backend: String

Name of the backend requiring configuration (e.g., "tcp").

missing_vars: Vec<String>

List of environment variable names that are not set.

Trait Implementations

impl Debug for BackendError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BackendError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for BackendError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.