Struct NixlBackendConfig 

pub struct NixlBackendConfig { /* private fields */ }

Configuration for NIXL backends.

Supports extracting backend configurations from environment variables:

• DYN_KVBM_NIXL_BACKEND_UCX=true - Enable UCX backend with default params
• DYN_KVBM_NIXL_BACKEND_GDS=false - Explicitly disable GDS backend
• Valid values: true/false, 1/0, on/off, yes/no (case-insensitive)
• Invalid values (e.g., “maybe”, “random”) will cause an error
• Custom params (e.g., DYN_KVBM_NIXL_BACKEND_UCX_PARAM1=value) will cause an error

Data Structure

Uses a single HashMap where:

• Key presence = backend is enabled
• Value (inner HashMap) = backend-specific parameters (empty = defaults)

TOML Example

[backends.UCX]
# UCX with default params (empty map)

[backends.GDS]
threads = "4"
buffer_size = "1048576"

Implementations

impl NixlBackendConfig

pub fn new(backends: HashMap<String, HashMap<String, String>>) -> Self

Creates a new configuration with the given backends.

For an empty configuration with no backends, use Default::default().

pub fn from_env() -> Result<Self>

Create configuration from environment variables.

Extracts backends from DYN_KVBM_NIXL_BACKEND_<backend>=<value> variables.

Errors

Returns an error if:

• Custom parameters are detected (not yet supported)
• Invalid boolean values are provided (must be truthy or falsey)

pub fn with_backend(self, backend: impl Into<String>) -> Self

Add a backend with default parameters. Backend name is normalized to uppercase.

pub fn with_backend_params( self, backend: impl Into<String>, params: HashMap<String, String>, ) -> Self

Add a backend with custom parameters. Backend name is normalized to uppercase.

pub fn backends(&self) -> Vec<String>

Get the list of enabled backend names (uppercase).

pub fn backend_params(&self, backend: &str) -> Option<&HashMap<String, String>>

Get parameters for a specific backend. Backend name is normalized to uppercase for lookup.

Returns None if the backend is not enabled.

pub fn has_backend(&self, backend: &str) -> bool

Check if a specific backend is enabled.

pub fn merge(self, other: NixlBackendConfig) -> Self

Merge another configuration into this one.

Backends from the other configuration will be added to this one. If both have the same backend, params from other take precedence.

pub fn iter(&self) -> impl Iterator<Item = (&String, &HashMap<String, String>)>

Iterate over all enabled backends and their parameters.

Trait Implementations

impl Clone for NixlBackendConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NixlBackendConfig

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

Formats the value using the given formatter.

impl Default for NixlBackendConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NixlBackendConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NixlBackendConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.