Struct DynamicAPIBuilder 

pub struct DynamicAPIBuilder { /* private fields */ }

A dynamic API server that can add and remove routes at runtime.

DynamicAPIBuilder serves HTTP and gRPC on a given address, multiplexing both protocols on a single port. Route additions and removals are handled by subscribing to assertions/retractions of DynamicRoute in the DataspaceRegistry.

Adding and removing routes

Any process that wants to dynamically register API routes can simply assert a DynamicRoute in the DataspaceRegistry. Retracting the assertion will remove the route, either when retracted manually or when the process owning the route assertions exits.

If the dynamic API server is restarted, it will re-register any routes that were previously asserted.

Static handlers and services

In addition to dynamic routes, callers can register static HTTP handlers and gRPC services up-front via with_handler, with_optional_handler, and with_grpc_service. These form a base router that’s cloned on every rebuild and merged with the currently asserted dynamic routes. Static routes take precedence on conflicts: a dynamic route whose path and method overlap with a static route is skipped (with a warning) until the conflict clears.

Assertions

• BoundApiAddress: the actual listen address bound by the API server. Identifier is "dynamic-<type>-api", where type is the stringified value of EndpointType::as_str (for example, "dynamic-privileged-api")

Implementations

impl DynamicAPIBuilder

pub fn new(endpoint_type: EndpointType, listen_address: ListenAddress) -> Self

Creates a new DynamicAPIBuilder for the given endpoint type and listen address.

pub fn with_handler<H>(self, handler: H) -> Self

where H: APIHandler,

Adds the given handler as a static HTTP handler.

The handler’s initial state and routes are merged into the base router. These routes are always served by the API regardless of which dynamic routes are currently asserted.

pub fn with_optional_handler<H>(self, handler: Option<H>) -> Self

where H: APIHandler,

Adds the given optional handler as a static HTTP handler.

If handler is Some, its initial state and routes are merged into the base router. Otherwise the builder is returned unchanged.

pub fn with_grpc_service<S>(self, svc: S) -> Self

where S: Service<Request<GrpcBody>, Response = Response<GrpcBody>, Error = Infallible> + NamedService + Clone + Send + Sync + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Adds the given gRPC service as a static service on the base router.

pub fn with_tls_config(self, config: ServerConfig) -> Self

Sets the TLS configuration for the server.

pub fn with_self_signed_tls(self) -> Self

Sets the TLS configuration for the server based on a dynamically generated, self-signed certificate.

Trait Implementations

impl Supervisable for DynamicAPIBuilder

fn name(&self) -> &str

Returns the name of the process.

fn initialize<'life0, 'async_trait>( &'life0 self, process_shutdown: ProcessShutdown, ) -> Pin<Box<dyn Future<Output = Result<SupervisorFuture, InitializationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initializes the process asynchronously.

fn shutdown_strategy(&self) -> ShutdownStrategy

Returns the shutdown strategy for the process.