Skip to main content

StandardResponse

Enum StandardResponse 

Source
pub enum StandardResponse<T = Value>{
    Confirmed {
        value: bool,
    },
    Text {
        value: T,
    },
    Selected {
        values: Vec<T>,
    },
    Custom {
        data: T,
    },
    Cancelled,
}
Expand description

Standard response types matching StandardRequest.

Each variant corresponds to a request type:

RequestResponse
ConfirmConfirmed { value: bool }
PromptText { value: T }
SelectSelected { values: Vec<T> }
AnyCancelled (user cancelled)

The type parameter T defaults to serde_json::Value for backwards compatibility.

§Wire Format

Uses internally-tagged JSON for consistency with TypeScript clients:

{ "type": "confirmed", "value": true }
{ "type": "text", "value": "user-input" }
{ "type": "selected", "values": ["dev"] }
{ "type": "cancelled" }

Variants§

§

Confirmed

User confirmed (true) or declined (false).

Response to StandardRequest::Confirm.

  • value: true = user said yes
  • value: false = user said no

Fields

§value: bool

Whether the user confirmed (true) or declined (false)

§

Text

User entered text or provided a value.

Response to StandardRequest::Prompt. May be empty if user submitted without entering text.

Fields

§value: T

The value entered or provided by the user

§

Selected

User selected one or more options (by value).

Response to StandardRequest::Select. Contains the value field(s) from selected SelectOptions.

  • For single-select: vector with exactly one element
  • For multi-select: vector with zero or more elements

Fields

§values: Vec<T>

The values of selected options

§

Custom

Custom domain-specific response payload.

Corresponds to StandardRequest::Custom or any request type where the application needs to return a custom response.

Fields

§data: T

The custom response data.

§

Cancelled

User cancelled the request.

Can be sent in response to any request type. Indicates the user chose to abort rather than respond. This is different from declining (Confirmed { value: false }) - cancel means “don’t proceed with the workflow at all”.

Trait Implementations§

Source§

impl<T> Clone for StandardResponse<T>

Source§

fn clone(&self) -> StandardResponse<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for StandardResponse<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, T> Deserialize<'de> for StandardResponse<T>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T> JsonSchema for StandardResponse<T>

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl<T> PartialEq for StandardResponse<T>

Source§

fn eq(&self, other: &StandardResponse<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Serialize for StandardResponse<T>

Source§

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. Read more
Source§

impl<T> StructuralPartialEq for StandardResponse<T>

Auto Trait Implementations§

§

impl<T> Freeze for StandardResponse<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for StandardResponse<T>
where T: RefUnwindSafe,

§

impl<T> Send for StandardResponse<T>
where T: Send,

§

impl<T> Sync for StandardResponse<T>
where T: Sync,

§

impl<T> Unpin for StandardResponse<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for StandardResponse<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for StandardResponse<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> MaybeSend for T
where T: Send,