Skip to main content

TaskStatusEvent

Struct TaskStatusEvent 

Source
pub struct TaskStatusEvent {
    pub task_id: String,
    pub queue: String,
    pub status: String,
    pub attempt: u32,
    pub done_in_ms: Option<u64>,
    pub result: Option<String>,
}
Expand description

A task-status event on the /events/status SSE stream.

A brand-new, apalis-rtui-owned event shape with no wire-compatibility obligation to upstream. Unlike Span, which carries no queue name, queue is included here so a server-side ?queue= filter is possible instead of a client-side one.

§Examples

use apalis_rtui_types::TaskStatusEvent;

let event = TaskStatusEvent {
    task_id: "01K7EXAMPLE".to_owned(),
    queue: "Emails".to_owned(),
    status: "Failed".to_owned(),
    attempt: 3,
    done_in_ms: Some(3200),
    result: Some("timed out".to_owned()),
};
let json = serde_json::to_string(&event).unwrap();
let back: TaskStatusEvent = serde_json::from_str(&json).unwrap();
assert_eq!(back, event);

Fields§

§task_id: String

The id of the task the event is about.

§queue: String

The queue the task runs on.

§status: String

The task’s status after this event (for example "Failed", "Done", "Running").

§attempt: u32

The attempt number this event reflects.

§done_in_ms: Option<u64>

How long the attempt took to finish, in milliseconds, once it finishes.

§result: Option<String>

The task’s result payload, once it finishes.

Trait Implementations§

Source§

impl Clone for TaskStatusEvent

Source§

fn clone(&self) -> Self

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 TaskStatusEvent

Source§

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

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

impl<'de> Deserialize<'de> for TaskStatusEvent

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 TaskStatusEvent

Source§

impl PartialEq for TaskStatusEvent

Source§

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

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 TaskStatusEvent

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.