obzenflow_core 0.2.1

Core domain layer for ObzenFlow - pure abstractions with minimal dependencies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// SPDX-License-Identifier: MIT OR Apache-2.0
// SPDX-FileCopyrightText: 2025-2026 ObzenFlow Contributors
// https://obzenflow.dev

//! Web server abstraction

use super::endpoint::HttpEndpoint;
use super::error::WebError;
use super::types::ServerConfig;
use async_trait::async_trait;

/// Trait for web server implementations
///
/// This trait is implemented by concrete web servers (Warp, Axum, Actix, etc.)
/// in the infrastructure layer. It provides a framework-agnostic interface
/// for starting servers and registering endpoints.
#[async_trait]
pub trait WebServer: Send + Sync {
    /// Register an HTTP endpoint with the server
    ///
    /// This method should be called before starting the server.
    /// Multiple endpoints can be registered.
    fn register_endpoint(&mut self, endpoint: Box<dyn HttpEndpoint>) -> Result<(), WebError>;

    /// Start the server with the given configuration
    ///
    /// This method will start the HTTP server and block until it's shut down.
    /// All endpoints should be registered before calling this method.
    async fn start(self, config: ServerConfig) -> Result<(), WebError>;

    /// Create a handle for graceful shutdown
    ///
    /// This returns a shutdown handle that can be used to stop the server.
    /// Not all implementations may support this.
    fn shutdown_handle(&self) -> Option<Box<dyn ServerShutdownHandle>>;
}

/// Handle for gracefully shutting down a server
#[async_trait]
pub trait ServerShutdownHandle: Send + Sync {
    /// Signal the server to shut down gracefully
    async fn shutdown(&self) -> Result<(), WebError>;

    /// Check if the server is still running
    fn is_running(&self) -> bool;
}

/// Builder trait for creating web servers with a fluent API
///
/// This is an optional trait that implementations can provide for
/// more ergonomic server creation.
pub trait WebServerBuilder: Sized {
    /// The type of server this builder creates
    type Server: WebServer;

    /// Create a new builder with default settings
    fn new() -> Self;

    /// Add an endpoint to the server
    fn endpoint(self, endpoint: Box<dyn HttpEndpoint>) -> Self;

    /// Add multiple endpoints to the server
    fn endpoints(self, endpoints: Vec<Box<dyn HttpEndpoint>>) -> Self;

    /// Build the server
    fn build(self) -> Result<Self::Server, WebError>;
}