Struct Task 

pub struct Task {
    pub id: Uuid,
    pub document_box: DocumentBoxScopeRaw,
    pub status: TaskStatus,
    pub output_data: Option<Value>,
    pub created_at: DateTime<Utc>,
    pub completed_at: Option<DateTime<Utc>>,
}

Represents a stored asynchronous task progress

Fields

id: Uuid

Unique ID of the task

document_box: DocumentBoxScopeRaw

ID of the document box the task belongs to

status: TaskStatus

Status of the task

output_data: Option<Value>

Output data from the task completion

created_at: DateTime<Utc>

When the task was created

completed_at: Option<DateTime<Utc>>

Implementations

impl Task

pub async fn create( db: impl DbExecutor<'_>, document_box: DocumentBoxScopeRaw, ) -> DbResult<Task>

Stores / updates the stored user data, returns back the user ID

pub async fn find( db: impl DbExecutor<'_>, id: TaskId, document_box: DocumentBoxScopeRawRef<'_>, ) -> DbResult<Option<Task>>

pub async fn complete_task( &mut self, db: impl DbExecutor<'_>, status: TaskStatus, output_data: Option<Value>, ) -> DbResult<()>

Mark the task as completed and set its output data

pub async fn delete_expired( db: impl DbExecutor<'_>, before: DateTime<Utc>, ) -> DbResult<PgQueryResult>

Deletes all tasks where the creation date is older than the before date

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Task

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Task

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

Formats the value using the given formatter.

impl<'a, R: Row> FromRow<'a, R> for Task

where &'a str: ColumnIndex<R>, Uuid: Decode<'a, R::Database> + Type<R::Database>, DocumentBoxScopeRaw: Decode<'a, R::Database> + Type<R::Database>, TaskStatus: Decode<'a, R::Database> + Type<R::Database>, Option<Value>: Decode<'a, R::Database> + Type<R::Database>, DateTime<Utc>: Decode<'a, R::Database> + Type<R::Database>, Option<DateTime<Utc>>: Decode<'a, R::Database> + Type<R::Database>,

fn from_row(__row: &'a R) -> Result<Self>

impl PartialEq for Task

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Task

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Eq for Task