Struct MethodSchema 

pub struct MethodSchema {
    pub name: String,
    pub description: String,
    pub hash: String,
    pub params: Option<Schema>,
    pub returns: Option<Schema>,
    pub streaming: bool,
    pub bidirectional: bool,
    pub http_method: HttpMethod,
    pub request_type: Option<Schema>,
    pub response_type: Option<Schema>,
}

Schema for a single method exposed by a plugin

Fields

name: String

Method name (e.g., “echo”, “check”)

description: String

Human-readable description of what this method does

hash: String

Content hash of the method definition (for cache invalidation) Generated by hashing the method signature within hub-macro

params: Option<Schema>

JSON Schema for the method’s parameters (None if no params)

returns: Option<Schema>

JSON Schema for the method’s return type (None if not specified)

streaming: bool

Whether this method streams multiple events (true) or returns a single result (false)

• streaming: true → returns AsyncGenerator<T> (multiple events)
• streaming: false → returns Promise<T> (single event, collected)

All methods use the same streaming protocol under the hood, but this flag tells clients how to present the result.

bidirectional: bool

Whether this method supports bidirectional communication

When true, the server can send requests to the client during method execution and wait for responses (e.g., confirmations, prompts, selections).

http_method: HttpMethod

HTTP method for REST endpoints (GET, POST, PUT, DELETE, PATCH)

This field is used by the HTTP gateway to determine which HTTP method to use when exposing this method as a REST endpoint. Defaults to POST for backward compatibility.

• GET: Idempotent read operations (no side effects)
• POST: Create operations or non-idempotent actions (default)
• PUT: Replace/update operations (idempotent)
• DELETE: Remove operations (idempotent)
• PATCH: Partial update operations

request_type: Option<Schema>

JSON Schema for the request type sent from server to client

Only relevant when bidirectional: true. Describes the structure of requests the server may send during method execution.

response_type: Option<Schema>

JSON Schema for the response type sent from client to server

Only relevant when bidirectional: true. Describes the structure of responses the client should send in reply to server requests.

Implementations

impl MethodSchema

pub fn new( name: impl Into<String>, description: impl Into<String>, hash: impl Into<String>, ) -> MethodSchema

Create a new method schema with name, description, and hash

The hash should be computed from the method definition string within the hub-macro at compile time.

pub fn with_params(self, params: Schema) -> MethodSchema

Add parameter schema

pub fn with_returns(self, returns: Schema) -> MethodSchema

Add return type schema

pub fn with_streaming(self, streaming: bool) -> MethodSchema

Set the streaming flag

• true → method streams multiple events (use AsyncGenerator<T>)
• false → method returns single result (use Promise<T>)

pub fn with_http_method(self, http_method: HttpMethod) -> MethodSchema

Set the HTTP method for REST endpoints

Defaults to POST for backward compatibility.

Guidelines

• GET: Idempotent read operations with no side effects
• POST: Create operations or non-idempotent actions
• PUT: Replace/update operations (idempotent)
• DELETE: Remove operations (idempotent)
• PATCH: Partial update operations

pub fn with_bidirectional(self, bidirectional: bool) -> MethodSchema

Set whether this method supports bidirectional communication

When true, the server can send requests to the client during method execution and wait for responses.

pub fn with_request_type(self, schema: Schema) -> MethodSchema

Set the JSON Schema for server-to-client request types

Only relevant when bidirectional: true. Use schema_for!(YourRequestType) to generate the schema.

pub fn with_response_type(self, schema: Schema) -> MethodSchema

Set the JSON Schema for client-to-server response types

Only relevant when bidirectional: true. Use schema_for!(YourResponseType) to generate the schema.

pub fn with_standard_bidirectional(self) -> MethodSchema

Configure method for standard bidirectional communication

Sets bidirectional: true and configures request/response types to use StandardRequest and StandardResponse, which support common UI patterns like confirmations, prompts, and selections.

Trait Implementations

impl Clone for MethodSchema

fn clone(&self) -> MethodSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MethodSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MethodSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MethodSchema

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 Serialize for MethodSchema

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.