Struct Binding 

pub struct Binding<PluginId, Ctx, Plugins = ExactlyOne<PluginId, PluginInstance<Ctx>>>(/* private fields */)
where
    PluginId: Hash + Eq + Clone + Send + Sync + 'static,
    Ctx: PluginContext + 'static,
    Plugins: Cardinality<PluginId, PluginInstance<Ctx>> + 'static,
    <Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>>: Send + Sync;

An abstract contract specifying what plugins must implement (via plugs) or what they could depend on (via sockets). It bundles one or more WIT Interfaces under a single package name.

Binding is a handle to shared state. Cloning a Binding creates another handle to the same underlying binding, enabling shared dependencies where multiple plugins depend on the same binding.

let binding: Binding<String, Ctx> = Binding::new(
	"my:package",
	HashMap::from([
		( "api".to_string(), Interface::new(
			HashMap::from([( "get-value".into(), Function::new(
				FunctionKind::Freestanding,
				ReturnKind::MayContainResources,
			))]),
			HashSet::from([ "my-resource".to_string() ]),
		)),
	]),
	ExactlyOne( "my-plugin".to_string(), plugin ),
);

// Clone for shared dependencies - both refer to the same binding
let binding_clone = binding.clone();

Type Parameters

• PluginId: Unique identifier type for plugins (e.g., String, UUID)

Implementations

impl<PluginId, Ctx, Plugins> Binding<PluginId, Ctx, Plugins>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static, Plugins: Cardinality<PluginId, PluginInstance<Ctx>> + 'static, <Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>>: Cardinality<PluginId, Mutex<PluginInstance<Ctx>>> + Send + Sync,

pub fn new( package_name: impl Into<String>, interfaces: HashMap<String, Interface>, plugins: Plugins, ) -> Self

Creates a new binding specification.

pub fn dispatch( &self, interface_name: &str, function_name: &str, args: &[Val], ) -> Result<<<Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>> as Cardinality<PluginId, Mutex<PluginInstance<Ctx>>>>::Rebind<Result<Val, DispatchError>>, DispatchError>

Dispatches a function call to all plugins implementing this binding.

This is used for external dispatch (calling into the plugin graph from outside). The result is wrapped in a type matching the binding’s cardinality.

Arguments

• interface_name - The interface name within this binding (e.g., “example”)
• function_name - The function name within the interface (e.g., “get-value”)
• args - Arguments to pass to the function

Returns

A cardinality wrapper containing Result<Val, DispatchError> for each plugin. For ReturnKind::Void, the value is an empty tuple (Val::Tuple( vec![] )) placeholder.

Errors

Returns an error if the interface or function is not found in this binding.

impl<PluginId, Ctx, Plugins> Binding<PluginId, Ctx, Plugins>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static, Plugins: Cardinality<PluginId, PluginInstance<Ctx>>, <Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>>: Send + Sync, BindingAny<PluginId, Ctx>: From<Binding<PluginId, Ctx, Plugins>>,

pub fn into_any(self) -> BindingAny<PluginId, Ctx>

Converts this binding into a type-erased BindingAny for heterogeneous socket lists.

Trait Implementations

impl<PluginId, Ctx, Plugins> Clone for Binding<PluginId, Ctx, Plugins>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static, Plugins: Cardinality<PluginId, PluginInstance<Ctx>> + 'static, <Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>>: Send + Sync,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PluginId, Ctx, Plugins> Debug for Binding<PluginId, Ctx, Plugins>

where PluginId: Hash + Eq + Clone + Send + Sync + Debug + 'static, Ctx: PluginContext + Debug + 'static, Plugins: Cardinality<PluginId, PluginInstance<Ctx>> + 'static, <Plugins as Cardinality<PluginId, PluginInstance<Ctx>>>::Rebind<Mutex<PluginInstance<Ctx>>>: Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<PluginId, Ctx> From<Binding<PluginId, Ctx>> for BindingAny<PluginId, Ctx>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static,

fn from( binding: Binding<PluginId, Ctx, ExactlyOne<PluginId, PluginInstance<Ctx>>>, ) -> Self

Converts to this type from the input type.

impl<PluginId, Ctx> From<Binding<PluginId, Ctx, Any<PluginId, PluginInstance<Ctx>>>> for BindingAny<PluginId, Ctx>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static,

fn from( binding: Binding<PluginId, Ctx, Any<PluginId, PluginInstance<Ctx>>>, ) -> Self

Converts to this type from the input type.

impl<PluginId, Ctx> From<Binding<PluginId, Ctx, AtLeastOne<PluginId, PluginInstance<Ctx>>>> for BindingAny<PluginId, Ctx>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static,

fn from( binding: Binding<PluginId, Ctx, AtLeastOne<PluginId, PluginInstance<Ctx>>>, ) -> Self

Converts to this type from the input type.

impl<PluginId, Ctx> From<Binding<PluginId, Ctx, AtMostOne<PluginId, PluginInstance<Ctx>>>> for BindingAny<PluginId, Ctx>

where PluginId: Hash + Eq + Clone + Send + Sync + 'static, Ctx: PluginContext + 'static,

fn from( binding: Binding<PluginId, Ctx, AtMostOne<PluginId, PluginInstance<Ctx>>>, ) -> Self

Converts to this type from the input type.