Struct ServerControlHook 

pub struct ServerControlHook { /* private fields */ }

Represents the hooks for managing the server’s lifecycle, specifically for waiting and shutting down.

This struct is returned by the run method and provides two key hooks:

• wait_hook- A future that resolves when the server has stopped accepting new connections.
• shutdown_hook- A function that can be called to gracefully shut down the server.

Implementations

impl ServerControlHook

Manages server lifecycle hooks, including waiting and shutdown procedures.

This struct holds closures that are executed during specific server lifecycle events.

pub async fn wait(&self)

Waits for the server’s shutdown signal or completion.

This method asynchronously waits until the server’s wait_hook is triggered, typically indicating that the server has finished its operations or is ready to shut down.

pub async fn shutdown(&self)

Initiates the server shutdown process.

This method asynchronously calls the shutdown_hook, which is responsible for performing any necessary cleanup or graceful shutdown procedures.

impl ServerControlHook

pub fn get_wait_hook(&self) -> &SharedAsyncTaskFactory<()>

pub fn get_shutdown_hook(&self) -> &SharedAsyncTaskFactory<()>

Trait Implementations

impl Clone for ServerControlHook

fn clone(&self) -> ServerControlHook

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerControlHook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ServerControlHook

Provides a default implementation for ServerControlHook.

fn default() -> Self

Creates a new ServerControlHook instance with default no-op hooks.

The default wait_hook and shutdown_hook do nothing, allowing the server to run without specific shutdown or wait logic unless configured otherwise.

Returns

• Self - A new ServerControlHook instance with default hooks.

impl Display for ServerControlHook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.