Skip to main content

OutputEvent

Enum OutputEvent 

Source
#[non_exhaustive]
pub enum OutputEvent { Chunk(OutputChunk), RunStarted { generation: u64, attempt: u32, started_at: SystemTime, }, RunFinished { generation: u64, attempt: u32, exit_code: Option<i32>, finished_at: SystemTime, }, Lagged { skipped: u64, }, }
Expand description

Event in a task live-output stream.

Run markers are the best effort. They are not ordering barriers for chunks.

§JSON Shape

{"type":"chunk","generation":2,"attempt":1,"stream":"stdout","seq":0,"ts":1700,"line":"aGVsbG8="}
{"type":"runStarted","generation":2,"attempt":1,"startedAt":1700}
{"type":"runFinished","generation":2,"attempt":1,"exitCode":0,"finishedAt":1701}
{"type":"lagged","skipped":42}

§Example

use bytes::Bytes;
use solti_model::{OutputChunk, OutputEvent, StreamKind};
use std::time::SystemTime;

let event = OutputEvent::Chunk(OutputChunk {
    generation: 2,
    attempt: 1,
    stream: StreamKind::Stdout,
    seq: 0,
    ts: SystemTime::UNIX_EPOCH,
    line: Bytes::from_static(b"hello"),
});

let json = serde_json::to_string(&event).unwrap();
assert!(json.contains(r#""type":"chunk""#));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Chunk(OutputChunk)

Carries stdout or stderr bytes from one run.

§

RunStarted

Reports that a run attempt started.

This marker is not an ordering barrier for chunks. Use each chunk’s generation, attempt, stream, and seq fields for grouping and ordering.

Fields

§generation: u64

Desired-state generation executed by this run.

§attempt: u32

Attempt number of the run that just started.

§started_at: SystemTime

Wall-clock start time (unix milliseconds on the wire).

§

RunFinished

Reports that a run attempt finished.

This marker is not an ordering barrier: chunks for the same generation and attempt may still be observed after it.

Fields

§generation: u64

Desired-state generation executed by this run.

§attempt: u32

Attempt number of the run that finished.

§exit_code: Option<i32>

Process exit code.

None means no exit code was available.

§finished_at: SystemTime

Wall-clock finish time (unix milliseconds on the wire).

§

Lagged

Reports events lost before the next delivered event.

Fields

§skipped: u64

Number of lost events.

Trait Implementations§

Source§

impl Clone for OutputEvent

Source§

fn clone(&self) -> OutputEvent

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 OutputEvent

Source§

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

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

impl<'de> Deserialize<'de> for OutputEvent

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 Eq for OutputEvent

Source§

impl JsonSchema for OutputEvent

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 PartialEq for OutputEvent

Source§

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

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 OutputEvent

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> 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, 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 = 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.