Enum DetailedTask 

#[non_exhaustive]
pub enum DetailedTask {
    Working {
        metadata: TaskMetadata,
    },
    InputRequired {
        metadata: TaskMetadata,
        input_requests: BTreeMap<String, InputRequest>,
    },
    Completed {
        metadata: TaskMetadata,
        result: Map<String, Value>,
    },
    Failed {
        metadata: TaskMetadata,
        error: JsonRpcError,
    },
    Cancelled {
        metadata: TaskMetadata,
    },
}

Complete status-specific task state returned by tasks/get and notifications/tasks.

The internally tagged representation guarantees that required payloads match their status: input_required has inputRequests, completed has result, and failed has error.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Working

Work is currently in progress.

Fields

metadata: TaskMetadata

Shared task fields.

InputRequired

Work is paused until the client fulfils the outstanding requests.

Fields

metadata: TaskMetadata

Shared task fields.

input_requests: BTreeMap<String, InputRequest>

All currently outstanding server-to-client requests.

Completed

Work completed successfully.

Tool results with isError: true still use this variant.

Fields

metadata: TaskMetadata

Shared task fields.

result: Map<String, Value>

The exact object the original synchronous request would return.

Failed

Execution failed with a JSON-RPC error.

Fields

metadata: TaskMetadata

Shared task fields.

error: JsonRpcError

Structured JSON-RPC execution error.

Cancelled

Work was cancelled before completion.

Fields

metadata: TaskMetadata

Shared task fields.

Implementations

impl DetailedTask

pub fn working(metadata: TaskMetadata) -> DetailedTask

Construct a working task.

pub fn input_required( metadata: TaskMetadata, input_requests: BTreeMap<String, InputRequest>, ) -> DetailedTask

Construct an input-required task.

pub fn completed( metadata: TaskMetadata, result: Map<String, Value>, ) -> DetailedTask

Construct a completed task from an object-valued synchronous result.

pub fn failed(metadata: TaskMetadata, error: JsonRpcError) -> DetailedTask

Construct a failed task from a structured JSON-RPC error.

pub fn cancelled(metadata: TaskMetadata) -> DetailedTask

Construct a cancelled task.

pub fn status(&self) -> TaskStatus

Current task status.

pub fn task_id(&self) -> &str

Server-generated identifier of the task this describes.

pub fn metadata(&self) -> &TaskMetadata

Shared task metadata.

pub fn input_requests(&self) -> Option<&BTreeMap<String, InputRequest>>

Outstanding requests when the task is input-required.

pub fn result(&self) -> Option<&Map<String, Value>>

Completed result object.

pub fn error(&self) -> Option<&JsonRpcError>

Failed JSON-RPC error.

Trait Implementations

impl Clone for DetailedTask

fn clone(&self) -> DetailedTask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetailedTask

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DetailedTask

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DetailedTask

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.