Skip to main content

PlexusStreamItem

Enum PlexusStreamItem 

Source
pub enum PlexusStreamItem {
    Data {
        metadata: StreamMetadata,
        content_type: String,
        content: Value,
    },
    Progress {
        metadata: StreamMetadata,
        message: String,
        percentage: Option<f32>,
    },
    Error {
        metadata: StreamMetadata,
        message: String,
        code: Option<String>,
        recoverable: bool,
    },
    Request {
        request_id: String,
        request_data: Value,
        timeout_ms: u64,
    },
    Done {
        metadata: StreamMetadata,
    },
}
Expand description

Universal stream item - all activations emit this type

The caller (DynamicHub routing layer) wraps activation responses with metadata. This is the only type that crosses the wire.

Variants§

§

Data

Data payload with caller-applied metadata

Fields

§metadata: StreamMetadata

Metadata from calling layer

§content_type: String

Type identifier for deserialization (e.g., “health.status”)

§content: Value

The actual payload (serialized activation event)

§

Progress

Progress update during long-running operations

Fields

§metadata: StreamMetadata

Metadata from calling layer

§message: String

Human-readable progress message

§percentage: Option<f32>

Optional completion percentage (0.0 - 100.0)

§

Error

Error occurred during processing

Fields

§metadata: StreamMetadata

Metadata from calling layer

§message: String

Human-readable error message

§code: Option<String>

Optional error code for programmatic handling

§recoverable: bool

Whether the operation can be retried

§

Request

Bidirectional request from server to client

Server can ask client for input during stream execution. Client must respond via transport-specific mechanism (MCP: _plexus_respond tool, WebSocket: plexus.respond RPC).

Fields

§request_id: String

Unique identifier for correlating response

§request_data: Value

Serialized request data (generic Req type)

§timeout_ms: u64

Maximum time to wait for response (milliseconds)

§

Done

Stream completed successfully

Fields

§metadata: StreamMetadata

Metadata from calling layer

Implementations§

Source§

impl PlexusStreamItem

Source

pub fn data( metadata: StreamMetadata, content_type: String, content: Value, ) -> PlexusStreamItem

Create a Data item

Source

pub fn progress( metadata: StreamMetadata, message: String, percentage: Option<f32>, ) -> PlexusStreamItem

Create a Progress item

Source

pub fn error( metadata: StreamMetadata, message: String, code: Option<String>, recoverable: bool, ) -> PlexusStreamItem

Create an Error item

Source

pub fn request( request_id: String, request_data: Value, timeout_ms: u64, ) -> PlexusStreamItem

Create a Request item

Source

pub fn done(metadata: StreamMetadata) -> PlexusStreamItem

Create a Done item

Source

pub fn metadata(&self) -> Option<&StreamMetadata>

Get the metadata from any stream item variant (if available)

Note: Request items don’t have metadata as they’re server-initiated

Trait Implementations§

Source§

impl Clone for PlexusStreamItem

Source§

fn clone(&self) -> PlexusStreamItem

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlexusStreamItem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PlexusStreamItem

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<PlexusStreamItem, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for PlexusStreamItem

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for PlexusStreamItem

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Container<T> for T
where T: Clone,

Source§

type Iter = Once<T>

An iterator over the items within this container, by value.
Source§

fn get_iter(&self) -> <T as Container<T>>::Iter

Iterate over the elements of the container (using internal iteration because GATs are unstable).
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> OrderedContainer<T> for T
where T: Clone,