Struct ResponsesApiProxyRequest 

pub struct ResponsesApiProxyRequest {
    pub api_key: String,
    pub port: Option<u16>,
    pub server_info_path: Option<PathBuf>,
    pub http_shutdown: bool,
    pub upstream_url: Option<String>,
}

Request for codex responses-api-proxy.

Fields

api_key: String

API key to write to stdin on startup.

port: Option<u16>

Optional port to bind; falls back to an OS-assigned ephemeral port when omitted.

server_info_path: Option<PathBuf>

Optional path passed to --server-info for {port,pid} JSON output.

http_shutdown: bool

Enables the HTTP shutdown endpoint (GET /shutdown).

upstream_url: Option<String>

Optional upstream URL passed to --upstream-url (defaults to https://api.openai.com/v1/responses).

Implementations

impl ResponsesApiProxyRequest

pub fn new(api_key: impl Into<String>) -> Self

Creates a request with the API key provided via stdin.

pub fn port(self, port: u16) -> Self

Sets the listening port (--port).

pub fn server_info(self, path: impl Into<PathBuf>) -> Self

Writes {port,pid} JSON to the provided path via --server-info.

pub fn http_shutdown(self, enable: bool) -> Self

Enables the --http-shutdown flag (GET /shutdown).

pub fn upstream_url(self, url: impl Into<String>) -> Self

Overrides the upstream responses endpoint URL.

Trait Implementations

impl Clone for ResponsesApiProxyRequest

fn clone(&self) -> ResponsesApiProxyRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponsesApiProxyRequest

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

Formats the value using the given formatter.

impl PartialEq for ResponsesApiProxyRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ResponsesApiProxyRequest

impl StructuralPartialEq for ResponsesApiProxyRequest