Skip to main content

Module plexus

Module plexus 

Source
Expand description

Plexus RPC module - re-exported from hub-core

This module re-exports all Plexus RPC types from hub-core to avoid duplication. Substrate-specific activations use these types via this re-export.

Modules§

bidirectional
Bidirectional streaming support for Plexus RPC
context
Global Plexus RPC context for sharing state with activations
dispatch
HubDispatch trait for method delegation
errors
DEPRECATED: Stream-based guidance replaces error data structures
hub_context
HubContext - generic parent context injection for hub-aware plugins
method_enum
Method enum schema trait for activations
middleware
DEPRECATED: Stream-based guidance replaces middleware
path
plexus
DynamicHub - the central routing layer for activations
schema
streaming
Streaming helpers for the caller-wraps architecture
types
Plexus RPC streaming types

Structs§

ActivationInfo
ActivationRegistry
Activation info needed for generating guided errors (DEPRECATED - kept for backwards compat)
BidirChannel
Generic bidirectional channel for type-safe server-to-client requests.
ChildHashes
ChildSummary
Summary of a child plugin
DynamicHub
DynamicHub - an activation that routes to dynamically registered child activations
GuidedError
Builder for creating guided JSON-RPC errors
GuidedErrorData
Error data with try field for guided discovery
GuidedErrorMiddleware
Middleware that enriches error responses with guided try suggestions (DEPRECATED - no-op)
Handle
Handle pointing to external data with versioning
MethodSchema
Schema for a single method exposed by a plugin
NoParent
A no-op context for plugins that don’t need parent access.
PlexusContext
Shared Plexus RPC context accessible to all activations
PluginHashes
Schema summary containing only hashes (for cache validation)
PluginSchema
A plugin’s schema with methods and child summaries.
Provenance
Tracks provenance through nested behavior calls
Schema
A complete JSON Schema with metadata
SchemaProperty
A property definition in a schema
SelectOption
An option in a StandardRequest::Select request.
StreamMetadata
Metadata applied by the caller when wrapping activation responses
TryRequest
A suggested JSON-RPC request to try next

Enums§

BidirError
Error types for bidirectional communication
PlexusError
PlexusStreamItem
Universal stream item - all activations emit this type
SchemaResult
Result of a schema query - either full plugin or single method
SchemaType
Schema type enumeration
StandardRequest
Standard request types for common interactive UI patterns.
StandardResponse
Standard response types matching StandardRequest.
StreamItem
Simple stream item for dispatch results
TransportErrorKind

Traits§

Activation
ChildRouter
Trait for activations that can route to child activations
HubContext
Trait for parent context that can be injected into child plugins.
HubDispatch
Trait for types that can dispatch method calls
MethodEnumSchema
Trait for method enums that can generate schema with const discriminators
ParentAware
Marker trait for plugins that accept parent context injection.

Functions§

create_bidir_stream
Create a bidirectional channel and wrap a stream, merging Request items
done_stream
Create a done stream
error_stream
Create an error stream
from_dispatch_stream
Create a PlexusStream from a dispatch stream (convenience function)
progress_stream
Create a progress stream
route_to_child
Route a method call to a child activation
wrap_stream
Wrap a typed stream into PlexusStream with automatic Done event
wrap_stream_with_bidir
Wrap a typed stream with bidirectional support

Type Aliases§

PlexusStream
Type alias for boxed stream of PlexusStreamItem
StandardBidirChannel
Type alias for standard interactive UI patterns.