Struct ServerBuilder 

pub struct ServerBuilder { /* private fields */ }

Builder for creating HTTP servers with auto-registered routes

Example

let app = ServerBuilder::new()
    .with_link_service(InMemoryLinkService::new())
    .register_module(MyModule)
    .build()?;

Implementations

impl ServerBuilder

pub fn new() -> Self

Create a new ServerBuilder

pub fn with_link_service(self, service: impl LinkService + 'static) -> Self

Set the link service (required)

pub fn with_custom_routes(self, routes: Router) -> Self

Add custom routes to the server

Use this to add routes that don’t fit the CRUD pattern, such as:

• Authentication endpoints (/login, /logout)
• OAuth flows (/oauth/token, /oauth/callback)
• Webhooks (/webhooks/stripe)
• Custom business logic endpoints

Example

use axum::{Router, routing::{post, get}, Json};
use serde_json::json;

let auth_routes = Router::new()
    .route("/login", post(login_handler))
    .route("/logout", post(logout_handler))
    .route("/oauth/token", post(oauth_token_handler));

ServerBuilder::new()
    .with_link_service(service)
    .with_custom_routes(auth_routes)
    .register_module(module)?
    .build()?;

pub fn with_event_bus(self, capacity: usize) -> Self

Enable the event bus for real-time notifications

When enabled, REST/GraphQL handlers will publish events for mutations, and real-time exposures (WebSocket, SSE) can subscribe to receive them.

Arguments

• capacity - Buffer size for the broadcast channel (recommended: 1024)

Example

ServerBuilder::new()
    .with_link_service(service)
    .with_event_bus(1024)
    .register_module(module)?
    .build_host()?;

pub fn with_sink_registry(self, registry: SinkRegistry) -> Self

Provide a pre-built sink registry (overrides auto-wiring from config)

Use this when you need full control over which sinks are registered. If not provided and sinks is present in config, sinks are auto-wired.

pub fn with_notification_store(self, store: Arc<NotificationStore>) -> Self

Provide a pre-built notification store

If not provided, one is auto-created when InApp sinks are configured.

pub fn with_device_token_store(self, store: Arc<DeviceTokenStore>) -> Self

Provide a pre-built device token store

If not provided, one is auto-created when sinks are configured.

pub fn with_preferences_store( self, store: Arc<NotificationPreferencesStore>, ) -> Self

Provide a pre-built notification preferences store

If not provided, one is auto-created when sinks are configured.

pub fn register_module(self, module: impl Module + 'static) -> Result<Self>

Register a module

This will:

1. Load the module’s configuration
2. Register all entities from the module
3. Store the module for entity fetching

pub fn build_host(self) -> Result<ServerHost>

Build the transport-agnostic host

This generates a ServerHost that can be used with any exposure type (REST, GraphQL, gRPC, etc.).

Returns

Returns a ServerHost containing all framework state.

pub fn build(self) -> Result<Router>

Build the final REST router

This generates:

• CRUD routes for all registered entities
• Link routes (bidirectional)
• Introspection routes

Note: This is a convenience method that builds the host and immediately exposes it via REST. For other exposure types, use build_host_arc().

pub async fn serve(self, addr: &str) -> Result<()>

Serve the application with graceful shutdown

This will:

• Bind to the provided address
• Start serving requests
• Handle SIGTERM and SIGINT (Ctrl+C) for graceful shutdown

Example

ServerBuilder::new()
    .with_link_service(service)
    .register_module(module)?
    .serve("127.0.0.1:3000").await?;

Trait Implementations

impl Default for ServerBuilder

fn default() -> Self

Returns the “default value” for a type.