Struct PluginDispatchContext 

#[non_exhaustive]
pub struct PluginDispatchContext {
    pub runtime_hints: RuntimeHints,
    pub shared_env: Vec<(String, String)>,
    pub plugin_env: HashMap<String, Vec<(String, String)>>,
    pub provider_override: Option<String>,
}

Per-dispatch runtime hints and environment overrides for plugin execution.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

runtime_hints: RuntimeHints

Runtime hints serialized into plugin requests.

shared_env: Vec<(String, String)>

Environment pairs injected into every plugin process.

plugin_env: HashMap<String, Vec<(String, String)>>

Additional environment pairs injected for specific plugins.

provider_override: Option<String>

Provider identifier forced by the caller, if any.

Implementations

impl PluginDispatchContext

pub fn new(runtime_hints: RuntimeHints) -> Self

Creates dispatch context from the required runtime hint payload.

Examples

use osp_cli::core::output::{ColorMode, OutputFormat, UnicodeMode};
use osp_cli::core::runtime::{RuntimeHints, RuntimeTerminalKind, UiVerbosity};
use osp_cli::plugin::PluginDispatchContext;

let context = PluginDispatchContext::new(RuntimeHints::new(
    UiVerbosity::Info,
    2,
    OutputFormat::Json,
    ColorMode::Always,
    UnicodeMode::Never,
))
.with_provider_override(Some("ldap".to_string()))
.with_shared_env([("OSP_FORMAT", "json")]);

assert_eq!(context.provider_override.as_deref(), Some("ldap"));
assert!(context.shared_env.iter().any(|(key, value)| key == "OSP_FORMAT" && value == "json"));
assert_eq!(context.runtime_hints.terminal_kind, RuntimeTerminalKind::Unknown);

pub fn with_shared_env<I, K, V>(self, shared_env: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Replaces the environment injected into every plugin process.

pub fn with_plugin_env( self, plugin_env: HashMap<String, Vec<(String, String)>>, ) -> Self

Replaces the environment injected for specific plugins.

pub fn with_provider_override(self, provider_override: Option<String>) -> Self

Replaces the optional forced provider identifier.

Trait Implementations

impl Clone for PluginDispatchContext

fn clone(&self) -> PluginDispatchContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginDispatchContext

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

Formats the value using the given formatter.

impl Default for PluginDispatchContext

fn default() -> PluginDispatchContext

Returns the “default value” for a type.