Skip to main content

StreamItem

Enum StreamItem 

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

One item of a Plexus response stream, as delivered by a Transport.

Variants§

§

Data

A payload item. content is the activation’s own event, still as JSON; [crate::decode] is what turns it into the method’s event type.

Fields

§content_type: Option<String>

e.g. "tickets.watch". Absent over REST + SSE.

§content: Value
§

Progress

A progress report. Carries no payload; never terminates the stream.

Fields

§message: String
§percentage: Option<f32>
§

Error

An in-band error raised by the hub or the activation — as opposed to a crate::TransportError, which is the connection failing. Terminates the stream.

Fields

§message: String
§recoverable: bool

The REST bridge does not emit this field; it defaults to false.

§

Request

A server-to-client request (bidirectional activations). The typed client has no answer channel, so [crate::decode] skips these; a consumer that needs them reads the raw StreamItem stream.

Fields

§request_id: String
§request_data: Value
§timeout_ms: u64
§

Done

Normal end of stream.

Fields

Implementations§

Source§

impl StreamItem

Source

pub fn data(content: Value) -> Self

Convenience constructor for a data item with no server metadata — the shape the REST + SSE bridge produces.

Source

pub fn done() -> Self

Convenience constructor for a terminal done item.

Source

pub fn is_terminal(&self) -> bool

true for the two variants after which no further item may arrive.

Source

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

The provenance metadata, when the transport carried it.

Trait Implementations§

Source§

impl Clone for StreamItem

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamItem

Source§

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

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

impl<'de> Deserialize<'de> for StreamItem

Source§

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

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

impl PartialEq for StreamItem

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for StreamItem

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StreamItem

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.