Enum Event 

pub enum Event<'t> {
    Start {
        version: Cow<'t, str>,
    },
    ProgressBytes {
        task: Cow<'t, str>,
        description: Cow<'t, str>,
        id: Cow<'t, str>,
        bytes_cached: u64,
        bytes: u64,
        bytes_total: u64,
        steps_cached: u64,
        steps: u64,
        steps_total: u64,
        subtasks: Vec<SubTaskBytes<'t>>,
    },
    ProgressSteps {
        task: Cow<'t, str>,
        description: Cow<'t, str>,
        id: Cow<'t, str>,
        steps_cached: u64,
        steps: u64,
        steps_total: u64,
        subtasks: Vec<SubTaskStep<'t>>,
    },
}

An event emitted as JSON.

Variants

Start

Fields

version: Cow<'t, str>

The semantic version of the progress protocol.

ProgressBytes

An incremental update to a container image layer download

Fields

task: Cow<'t, str>

A machine readable type (e.g., pulling) for the task (used for i18n and UI customization).

description: Cow<'t, str>

A human readable description of the task if i18n is not available.

id: Cow<'t, str>

A human and machine readable unique identifier for the task (e.g., the image name). For tasks that only happen once, it can be set to the same value as task.

bytes_cached: u64

The number of bytes fetched by a previous run.

bytes: u64

The number of bytes already fetched.

bytes_total: u64

Total number of bytes. If zero, then this should be considered “unspecified”.

steps_cached: u64

The number of steps fetched by a previous run.

steps: u64

The initial position of progress.

steps_total: u64

The total number of steps (e.g. container image layers, RPMs)

subtasks: Vec<SubTaskBytes<'t>>

The currently running subtasks.

ProgressSteps

An incremental update with discrete steps

Fields

task: Cow<'t, str>

A machine readable type (e.g., pulling) for the task (used for i18n and UI customization).

description: Cow<'t, str>

A human readable description of the task if i18n is not available.

id: Cow<'t, str>

A human and machine readable unique identifier for the task (e.g., the image name). For tasks that only happen once, it can be set to the same value as task.

steps_cached: u64

The number of steps fetched by a previous run.

steps: u64

The initial position of progress.

steps_total: u64

The total number of steps (e.g. container image layers, RPMs)

subtasks: Vec<SubTaskStep<'t>>

The currently running subtasks.

Trait Implementations

impl<'t> Clone for Event<'t>

fn clone(&self) -> Event<'t>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for Event<'t>

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

Formats the value using the given formatter.

impl<'de: 't, 't> Deserialize<'de> for Event<'t>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'t> JsonSchema for Event<'t>

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<'t> PartialEq for Event<'t>

fn eq(&self, other: &Event<'t>) -> 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<'t> Serialize for Event<'t>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'t> Eq for Event<'t>

impl<'t> StructuralPartialEq for Event<'t>