Struct ProgressEvent 

pub struct ProgressEvent { /* private fields */ }

One bounded monotonic progress update for an operation.

Implementations

impl ProgressEvent

pub fn new( operation_id: OperationId, operation: OperationName, sequence: u64, occurred_at: Timestamp, phase: impl Into<String>, ) -> Result<Self, ProgressError>

Creates a progress event without a known quantity.

pub fn with_amount( self, current: u64, total: Option<u64>, unit: Option<impl Into<String>>, ) -> Result<Self, ProgressError>

Adds a current quantity, optional total, and optional unit.

pub fn with_message( self, message: impl Into<String>, ) -> Result<Self, ProgressError>

Adds a bounded human-readable progress message.

pub fn operation_id(&self) -> &OperationId

Returns the operation identity.

pub fn operation(&self) -> &OperationName

Returns the canonical operation name.

pub const fn sequence(&self) -> u64

Returns the monotonic, one-based event sequence.

pub const fn occurred_at(&self) -> Timestamp

Returns the event timestamp.

pub fn phase(&self) -> &str

Returns the current operation phase.

pub const fn current(&self) -> Option<u64>

Returns the current quantity when known.

pub const fn total(&self) -> Option<u64>

Returns the total quantity when known.

pub fn unit(&self) -> Option<&str>

Returns the quantity unit when present.

pub fn message(&self) -> Option<&str>

Returns the bounded progress message when present.

Trait Implementations

impl Clone for ProgressEvent

fn clone(&self) -> ProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ProgressEvent

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 ProgressEvent

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

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 ProgressEvent

impl StructuralPartialEq for ProgressEvent