Struct ModuleContext 

pub struct ModuleContext {
    pub module_id: String,
    pub socket_path: String,
    pub data_dir: String,
    pub config: HashMap<String, String>,
}

Context provided to modules for communication with node

This is the interface modules use to communicate with the base node. All communication goes through IPC, so this is essentially a handle to the IPC connection.

Fields

module_id: String

Module ID (unique identifier for this module instance)

socket_path: String

IPC socket path (Unix domain socket path for communication)

data_dir: String

Module data directory (where module can store its state)

config: HashMap<String, String>

Module configuration (key-value pairs from config file)

Implementations

impl ModuleContext

pub fn new( module_id: String, socket_path: String, data_dir: String, config: HashMap<String, String>, ) -> ModuleContext

Create a new module context

pub fn get_config(&self, key: &str) -> Option<&String>

Get a configuration value

pub fn get_config_or(&self, key: &str, default: &str) -> String

Get a configuration value with default

Trait Implementations

impl Clone for ModuleContext

fn clone(&self) -> ModuleContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleContext

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

Formats the value using the given formatter.