Struct ApiStreamEvent 

pub struct ApiStreamEvent {
    pub event: StreamEventKind,
    pub operation: String,
    pub message: Option<String>,
    pub project_name: Option<String>,
    pub runtime: Option<RuntimeStatus>,
    pub payload: Option<Value>,
    pub error_kind: Option<ErrorKind>,
    pub metadata: Option<ApiMetadata>,
}

A single streaming API event. Each serialized event is one NDJSON line.

Fields

event: StreamEventKind

operation: String

message: Option<String>

project_name: Option<String>

runtime: Option<RuntimeStatus>

payload: Option<Value>

error_kind: Option<ErrorKind>

metadata: Option<ApiMetadata>

Implementations

impl ApiStreamEvent

pub fn project_status( event: StreamEventKind, response: &ProjectStatusResponse, message: Option<&str>, ) -> Self

Creates a stream event for the project status operation.

pub fn operation( event: StreamEventKind, operation: impl Into<String>, metadata: ApiMetadata, message: Option<&str>, payload: Option<Value>, ) -> Self

Creates a generic streaming event for non-status operations.

Trait Implementations

impl Clone for ApiStreamEvent

fn clone(&self) -> ApiStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiStreamEvent

fn eq(&self, other: &ApiStreamEvent) -> 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 ApiStreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApiStreamEvent

impl StructuralPartialEq for ApiStreamEvent