Enum ServerRequest 

pub enum ServerRequest {
    CommandExecutionRequestApproval {
        request_id: RequestId,
        params: CommandExecutionRequestApprovalParams,
    },
    FileChangeRequestApproval {
        request_id: RequestId,
        params: FileChangeRequestApprovalParams,
    },
    ToolRequestUserInput {
        request_id: RequestId,
        params: ToolRequestUserInputParams,
    },
    McpServerElicitationRequest {
        request_id: RequestId,
        params: McpServerElicitationRequestParams,
    },
    PermissionsRequestApproval {
        request_id: RequestId,
        params: PermissionsRequestApprovalParams,
    },
    DynamicToolCall {
        request_id: RequestId,
        params: DynamicToolCallParams,
    },
    ChatgptAuthTokensRefresh {
        request_id: RequestId,
        params: ChatgptAuthTokensRefreshParams,
    },
    AttestationGenerate {
        request_id: RequestId,
        params: AttestationGenerateParams,
    },
    CurrentTimeRead {
        request_id: RequestId,
        params: CurrentTimeReadParams,
    },
    ApplyPatchApproval {
        request_id: RequestId,
        params: ApplyPatchApprovalParams,
    },
    ExecCommandApproval {
        request_id: RequestId,
        params: ExecCommandApprovalParams,
    },
}

Request initiated from the server and sent to the client.

Variants

CommandExecutionRequestApproval

NEW APIs Sent when approval is requested for a specific command execution. This request is used for Turns started via turn/start.

Fields

request_id: RequestId

params: CommandExecutionRequestApprovalParams

FileChangeRequestApproval

Sent when approval is requested for a specific file change. This request is used for Turns started via turn/start.

Fields

request_id: RequestId

params: FileChangeRequestApprovalParams

ToolRequestUserInput

EXPERIMENTAL - Request input from the user for a tool call.

Fields

request_id: RequestId

params: ToolRequestUserInputParams

McpServerElicitationRequest

Request input for an MCP server elicitation.

Fields

request_id: RequestId

params: McpServerElicitationRequestParams

PermissionsRequestApproval

Request approval for additional permissions from the user.

Fields

request_id: RequestId

params: PermissionsRequestApprovalParams

DynamicToolCall

Execute a dynamic tool call on the client.

Fields

request_id: RequestId

params: DynamicToolCallParams

ChatgptAuthTokensRefresh

Fields

request_id: RequestId

params: ChatgptAuthTokensRefreshParams

AttestationGenerate

Generate a fresh upstream attestation result on demand.

Fields

request_id: RequestId

params: AttestationGenerateParams

CurrentTimeRead

Read the current time from an external clock owned by the client.

Fields

request_id: RequestId

params: CurrentTimeReadParams

ApplyPatchApproval

DEPRECATED APIs below Request to approve a patch. This request is used for Turns started via the legacy APIs (i.e. SendUserTurn, SendUserMessage).

Fields

request_id: RequestId

params: ApplyPatchApprovalParams

ExecCommandApproval

Request to exec a command. This request is used for Turns started via the legacy APIs (i.e. SendUserTurn, SendUserMessage).

Fields

request_id: RequestId

params: ExecCommandApprovalParams

Implementations

impl ServerRequest

pub fn id(&self) -> &RequestId

pub fn response_from_result(&self, result: Result) -> Result<ServerResponse>

Trait Implementations

impl Clone for ServerRequest

fn clone(&self) -> ServerRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ServerRequest

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ServerRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ServerRequest

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 ServerRequest

impl TS for ServerRequest

type WithoutGenerics = ServerRequest

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ServerRequest

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl TryFrom<JSONRPCRequest> for ServerRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JSONRPCRequest) -> Result<Self, Self::Error>

Performs the conversion.