Skip to main content

Event

Struct Event 

Source
pub struct Event<O: Clone> {
    pub kind: EventKind,
    pub task_id: Uuid,
    pub worker_id: String,
    pub progress: Option<Progress>,
    pub data: Option<O>,
    pub error: Option<String>,
    pub timestamp: DateTime<Utc>,
}
Expand description

Event emitted by a worker task on the event channel.

Fields§

§kind: EventKind

The kind of this event.

§task_id: Uuid

Identifier of the task that produced this event.

§worker_id: String

Identifier of the worker that produced this event.

§progress: Option<Progress>

Progress snapshot, present for EventKind::Progress events.

§data: Option<O>

Task output payload, present for Partial and Result events.

§error: Option<String>

Error or log message, present for Error and Log events.

§timestamp: DateTime<Utc>

Wall-clock time at which the event was created.

Implementations§

Source§

impl<O: Clone> Event<O>

Source

pub fn progress( task_id: Uuid, worker_id: impl Into<String>, p: Progress, ) -> Self

Create a progress event carrying the given Progress snapshot.

Source

pub fn partial(task_id: Uuid, worker_id: impl Into<String>, data: O) -> Self

Create a partial-result event carrying an intermediate output value.

Source

pub fn log( task_id: Uuid, worker_id: impl Into<String>, message: impl Into<String>, ) -> Self

Create a log event carrying a free-form text message.

Source

pub fn result(task_id: Uuid, worker_id: impl Into<String>, data: O) -> Self

Create a final-result event carrying the successful task output.

Source

pub fn error( task_id: Uuid, worker_id: impl Into<String>, err: impl Into<String>, ) -> Self

Create an error event carrying the failure message.

Trait Implementations§

Source§

impl<O: Clone + Clone> Clone for Event<O>

Source§

fn clone(&self) -> Event<O>

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<O: Debug + Clone> Debug for Event<O>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<O> Freeze for Event<O>
where O: Freeze,

§

impl<O> RefUnwindSafe for Event<O>
where O: RefUnwindSafe,

§

impl<O> Send for Event<O>
where O: Send,

§

impl<O> Sync for Event<O>
where O: Sync,

§

impl<O> Unpin for Event<O>
where O: Unpin,

§

impl<O> UnsafeUnpin for Event<O>
where O: UnsafeUnpin,

§

impl<O> UnwindSafe for Event<O>
where O: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more