Struct ResultType 

pub struct ResultType(/* private fields */);

Indicates the type of a result object, allowing the client to determine how to parse the response.

The spec defines this as an open string ("complete" | "input_required" | string), so unknown values are preserved rather than rejected. Servers implementing this protocol version MUST include resultType in every result. For backward compatibility, clients MUST treat an absent field as "complete".

Ordinary results model the field as Option<ResultType>: None means the field is absent on the wire. Constructors default to Some(COMPLETE), and the server handler strips the "complete" discriminator before responding to peers that negotiated a protocol version older than 2026-07-28, so legacy sessions keep their historical wire shape (see ServerResult::strip_result_type_for_legacy_peer).

Implementations

impl ResultType

pub const COMPLETE: Self

pub const INPUT_REQUIRED: Self

pub const TASK: Self

SEP-2663 Tasks extension: the result is a task handle (CreateTaskResult).

pub fn as_str(&self) -> &str

pub fn is_input_required(&self) -> bool

Returns true if this is "input_required".

pub fn is_complete(&self) -> bool

Returns true if this is "complete".

pub fn is_task(&self) -> bool

Returns true if this is "task" (SEP-2663 Tasks extension).

Trait Implementations

impl Clone for ResultType

fn clone(&self) -> ResultType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResultType

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

Formats the value using the given formatter.

impl Default for ResultType

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResultType

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResultType

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

Formats the value using the given formatter.

impl Eq for ResultType

impl JsonSchema for ResultType

Available on crate feature schemars only.

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 ResultType

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResultType

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResultType