Enum RunOutcome 

pub enum RunOutcome {
    Success,
    Interrupt {
        interrupts: Vec<Interrupt>,
    },
}

How a run ended.

The field is optional on RUN_FINISHED: producers that predate the interrupt protocol omit it entirely, which consumers must read as success.

Variants

Success

The run completed.

Interrupt

The run is paused, waiting on the answers to interrupts.

Fields

interrupts: Vec<Interrupt>

The pending requests. The protocol requires at least one; see RunOutcome::validate.

Implementations

impl RunOutcome

pub fn interrupt(interrupts: impl Into<Vec<Interrupt>>) -> Self

Builds an interrupt outcome.

pub const fn is_interrupt(&self) -> bool

Whether the run is paused rather than finished.

pub fn interrupts(&self) -> &[Interrupt]

The pending interrupts, or an empty slice for a success outcome.

pub fn validate(&self) -> Result<()>

Checks the one rule the type system cannot: an interrupt outcome must carry at least one interrupt.

Deserializing does not enforce this, so that a stray empty array from a buggy producer surfaces as a protocol error you can log rather than as an unparseable event that kills the stream.

Trait Implementations

impl Clone for RunOutcome

fn clone(&self) -> RunOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for RunOutcome

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for RunOutcome

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunOutcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RunOutcome

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 RunOutcome

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

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 RunOutcome

impl ToSchema for RunOutcome

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.