Skip to main content

Crate brokkr_client

Crate brokkr_client 

Source
Expand description

Auto-generated Rust client for the Brokkr broker API.

Every type and method in this crate is generated at compile time by the progenitor::generate_api! macro from spec/brokkr-v1.json. That file is kept byte-identical to the workspace-canonical openapi/brokkr-v1.json by angreal openapi export and asserted by angreal openapi check — the in-crate copy exists so the spec ships with the published crate. Do not edit the generated surface; regenerate the spec via angreal openapi export after broker changes.

This crate is intentionally a thin wire-level client. The ergonomic wrapper (auth, retries, pagination, typed errors) lives in a separate layer added by task BROKKR-T-0137 (C1).

Modules§

builder
Types for composing operation parameters.
prelude
Items consumers will typically use such as the Client.
types
Types used as operation parameters and responses.

Structs§

BrokkrClient
Ergonomic client for the Brokkr broker API.
BrokkrClientBuilder
Builder for BrokkrClient. Use BrokkrClient::builder to start.
ByteStream
Untyped byte stream used for both success and error responses.
Client
Client for brokkr-broker
ResponseValue
Typed value returned by generated client methods.

Enums§

ApplyOutcome
Outcome of BrokkrClient::apply.
BrokkrError
Top-level error returned by every wrapper method. Mirrors progenitor_client::Error but specialises E to ErrorResponse so callers can match on ErrorResponse::code directly.
Error
Error produced by generated client methods.

Traits§

ClientInfo
Interface for which an implementation is generated for all clients.