bentoml 0.5.0

An unofficial async Rust client for BentoML services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! Async task-queue models.

use jiff::Timestamp;
use jiff::civil::DateTime;
use serde::{Deserialize, Serialize};

/// The lifecycle state of a submitted task.
///
/// Each variant is pinned to the exact wire value used by BentoML's `ResultStatus`,
/// rather than derived from the variant name.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub enum TaskStatus {
    /// Queued, not yet started.
    #[serde(rename = "pending")]
    Pending,
    /// Currently executing.
    #[serde(rename = "in_progress")]
    InProgress,
    /// Finished successfully; the result is available via [`TaskHandle::json`]
    /// (or `bytes` / `text`).
    ///
    /// [`TaskHandle::json`]: crate::task::TaskHandle::json
    #[serde(rename = "completed")]
    Completed,
    /// Finished with an error.
    #[serde(rename = "failed")]
    Failed,
    /// Canceled before execution.
    #[serde(rename = "canceled")]
    Canceled,
}

impl TaskStatus {
    /// Whether the task has reached a terminal state (completed, failed, canceled).
    pub fn is_terminal(self) -> bool {
        matches!(self, Self::Completed | Self::Failed | Self::Canceled)
    }
}

/// The status payload returned by the `submit` and `status` task endpoints.
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct TaskInfo {
    /// The unique identifier of the task.
    pub task_id: String,
    /// The current status of the task.
    pub status: TaskStatus,
    /// When the task was submitted.
    ///
    /// Absent from the `submit` response, present from `status`. BentoML reports
    /// this as a naive (offset-less) UTC datetime.
    #[serde(default)]
    pub created_at: Option<DateTime>,
    /// When the task began executing, if it has started.
    ///
    /// BentoML reports this as a naive (offset-less) UTC datetime.
    #[serde(default)]
    pub executed_at: Option<DateTime>,
    /// When the task finished, if it has completed.
    ///
    /// Unlike the other two, BentoML reports this as a timezone-aware UTC instant,
    /// hence [`Timestamp`] rather than [`DateTime`].
    #[serde(default)]
    pub completed_at: Option<Timestamp>,
}