Struct ServerOptions 

#[non_exhaustive]
pub struct ServerOptions {
    pub path: String,
    pub cors: CorsOptions,
    pub health_endpoint: bool,
}

Available on crate feature server only.

Configuration for an AcpHttpServer.

Start with Self::default and use the fluent setters to customize it. Fields remain public for reading and mutation, but this type is non-exhaustive so new options can be added without breaking callers.

use agent_client_protocol_http::{CorsOptions, ServerOptions};

let options = ServerOptions::default()
    .with_path("/agent")
    .with_cors(CorsOptions::allow_origins(["https://example.com"])?)
    .with_health_endpoint(false);
assert_eq!(options.path, "/agent");
assert!(!options.health_endpoint);

Struct literals, including struct update syntax, are not supported outside this crate:

use agent_client_protocol_http::ServerOptions;

let options = ServerOptions {
    path: "/agent".into(),
    ..ServerOptions::default()
};

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.

path: String

ACP endpoint path. Defaults to /acp.

cors: CorsOptions

Browser origin policy. Defaults to CorsOptions::Disabled.

health_endpoint: bool

Whether to expose GET /health. Defaults to true.

Implementations

impl ServerOptions

pub fn with_path(self, path: impl Into<String>) -> Self

Set the ACP endpoint path.

pub fn with_cors(self, cors: CorsOptions) -> Self

Set the browser origin policy.

CORS does not authenticate requests. The built-in CORS layer does not allow the Authorization request header or enable credentialed CORS. Authentication and custom credential policies belong to the host router.

pub fn with_health_endpoint(self, enabled: bool) -> Self

Enable or disable the GET /health endpoint.

Trait Implementations

impl Clone for ServerOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerOptions

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

Formats the value using the given formatter.

impl Default for ServerOptions

fn default() -> Self

Returns the “default value” for a type.