Enum ApiCallEnvelope 

pub enum ApiCallEnvelope {
    Begin,
    Chunk {
        chunk: Value,
    },
    Error {
        error: Value,
    },
    End,
}

Wire-format envelope for each value the viewer host emits as Event::ApiCall.value while servicing one api-call-invoke request.

Mirrors the cli’s Output<T> envelope shape so iframe consumers can apply the same JSONL state machine to both:

1. Begin — exactly one, emitted before any data.
2. Chunk { chunk } — one per SSE event for streaming endpoints, or one total for unary endpoints (carrying the parsed response body).
3. Error { error } — only on dispatch failure; replaces any further Chunks for that invocation.
4. End — exactly one, emitted last; signals the AsyncIterable on the JS side to terminate.

Variants

Begin

Chunk

Fields

chunk: Value

Error

Fields

error: Value

End

Trait Implementations

impl Clone for ApiCallEnvelope

fn clone(&self) -> ApiCallEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiCallEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiCallEnvelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ApiCallEnvelope

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl PartialEq for ApiCallEnvelope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ApiCallEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiCallEnvelope