switchy_web_server_core 0.3.0

Switchy Web Server Core package
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

//! Core abstractions for web server implementations.
//!
//! This crate provides the [`WebServer`] trait, which defines a common interface
//! for web server lifecycle management across different implementations.

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
#![allow(clippy::multiple_crate_versions)]

use std::{future::Future, pin::Pin};

/// A trait for managing the lifecycle of a web server.
///
/// Implementors of this trait provide asynchronous methods for starting and
/// stopping web server instances.
pub trait WebServer {
    /// Starts the web server.
    ///
    /// This method initiates the web server, binding to configured addresses
    /// and beginning to accept incoming connections.
    fn start(&self) -> Pin<Box<dyn Future<Output = ()>>>;

    /// Stops the web server.
    ///
    /// This method gracefully shuts down the web server, closing active
    /// connections and releasing resources.
    fn stop(&self) -> Pin<Box<dyn Future<Output = ()>>>;
}