Struct Task 

#[non_exhaustive]
pub struct Task {
    pub task_id: String,
    pub status: TaskStatus,
    pub status_message: Option<String>,
    pub created_at: String,
    pub last_updated_at: String,
    pub ttl_ms: Option<u64>,
    pub poll_interval_ms: Option<u64>,
}

Operational metadata about ongoing work (spec Task, SEP-2663).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_id: String

Stable identifier for this task, generated by the server.

status: TaskStatus

Current task status.

status_message: Option<String>

Optional message describing the current task state. This MAY be exposed to the end-user or model.

created_at: String

ISO 8601 timestamp when the task was created.

last_updated_at: String

ISO 8601 timestamp when the task was last updated.

ttl_ms: Option<u64>

Time-to-live duration from creation in integer milliseconds; None (serialized as null) means unlimited. The server may discard the task after the TTL elapses. This value MAY change over the lifetime of a task.

poll_interval_ms: Option<u64>

Suggested polling interval in integer milliseconds. Clients SHOULD honor this value to avoid overwhelming the server. This value MAY change over the lifetime of a task.

Implementations

impl Task

pub fn new( task_id: impl Into<String>, status: TaskStatus, created_at: impl Into<String>, last_updated_at: impl Into<String>, ) -> Task

Create a new task with required fields.

pub fn with_status_message(self, status_message: impl Into<String>) -> Task

Set the status message.

pub fn with_ttl_ms(self, ttl_ms: u64) -> Task

Set the TTL in milliseconds. None means unlimited retention.

pub fn with_poll_interval_ms(self, poll_interval_ms: u64) -> Task

Set the suggested poll interval in milliseconds.

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 Debug for Task

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

Formats the value using the given formatter.

impl Default for Task

fn default() -> Task

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Task

fn deserialize<__D>( __deserializer: __D, ) -> Result<Task, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Task

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 Task

fn eq(&self, other: &Task) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Task

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Task