Struct HyperServer

pub struct HyperServer { /* private fields */ }

Hyper server struct for managing the Axum-based web server

Implementations

impl HyperServer

pub fn state(&self) -> Arc<AppState>

Returns a shared reference to the application state

Returns

• Arc<AppState> - Shared application state

pub fn with_route(self, path: &'static str, route: MethodRouter) -> Self

Adds a new route to the server

Arguments

• path - The route path (static string)
• route - The Axum MethodRouter for handling the route

Returns

• Self - The modified HyperServer instance

pub async fn server_info( &self, addr: Option<SocketAddr>, ) -> TransportServerResult<String>

Generates server information string

Constructs a string describing the server type, protocol, address, and SSE endpoint.

Arguments

• addr - Optional SocketAddr; if None, resolves from options

Returns

• TransportServerResult<String> - The server information string or an error

pub fn server_handle(&self) -> Handle

Returns server handle that could be used for graceful shutdown

pub async fn start(self) -> TransportServerResult<()>

Starts the server, choosing SSL or HTTP based on configuration

Resolves the server address and starts the server in either SSL or HTTP mode. Panics if SSL is requested but the “ssl” feature is not enabled.

Returns

• TransportServerResult<()> - Ok if the server starts successfully, Err otherwise