Struct DetailedTask 

#[non_exhaustive]
pub struct DetailedTask {
    pub task: Task,
    pub payload: TaskPayload,
}

A task with its status-specific payload inlined (spec DetailedTask).

Used by tasks/get responses (GetTaskResult) and notifications/tasks (TaskStatusNotificationParams). On the wire, the payload fields (inputRequests / result / error) are flattened at the top level next to the base Task fields, and status discriminates the variant.

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: Task

Base task metadata. Its status always agrees with the payload.

payload: TaskPayload

Status-specific payload.

Implementations

impl DetailedTask

pub fn new(task: Task, payload: TaskPayload) -> DetailedTask

Build a DetailedTask, forcing task.status to match the payload.

pub fn status(&self) -> TaskStatus

The current status.

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 From<DetailedTask> for TaskStatusNotificationParams

fn from(task: DetailedTask) -> TaskStatusNotificationParams

Converts to this type from the input type.

impl JsonSchema for DetailedTask

Available on crate feature schemars only.

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

The name of the generated JSON Schema.

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.

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

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for DetailedTask

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for DetailedTask

impl TryFrom<DetailedTaskWire> for DetailedTask

type Error = String

The type returned in the event of a conversion error.

fn try_from(wire: DetailedTaskWire) -> Result<DetailedTask, String>

Performs the conversion.