Struct ServerManager

pub struct ServerManager { /* private fields */ }

Main structure for managing server processes.

Implementations

impl ServerManager

Implementation of server management operations.

Provides methods for starting, stopping and managing server processes.

pub fn new() -> Self

Creates a new ServerManager instance.

This is a convenience method that calls ServerManager::default().

pub fn set_pid_file<P: ToString>(&mut self, pid_file: P) -> &mut Self

Sets the path to the PID file.

Arguments

• pid_file - A string or any type that can be converted to a string representing the PID file path.

pub fn set_start_hook<F, Fut>(&mut self, func: F) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the asynchronous function to be called before the server starts.

Arguments

• F - An asynchronous function or closure to be executed.

pub fn set_server_hook<F, Fut>(&mut self, func: F) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the main server function to be executed.

Arguments

• F - The primary asynchronous function or closure for the server’s logic.

pub fn set_stop_hook<F, Fut>(&mut self, func: F) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the asynchronous function to be called before the server stops.

Arguments

• F - An asynchronous function or closure to be executed for cleanup.

pub fn get_pid_file(&self) -> &str

Gets the configured PID file path.

pub fn get_start_hook(&self) -> &ServerManagerHook

Gets a reference to the start hook.

pub fn get_server_hook(&self) -> &ServerManagerHook

Gets a reference to the server hook.

pub fn get_stop_hook(&self) -> &ServerManagerHook

Gets a reference to the stop hook.

pub async fn start(&self)

Starts the server in foreground mode.

Writes the current process ID to the PID file and executes the server function.

pub async fn stop(&self) -> ServerManagerResult

Stops the running server process.

Reads PID from file and terminates the process.

Returns

• ServerManagerResult - Operation result.

pub async fn start_daemon(&self) -> ServerManagerResult

Starts the server in daemon (background) mode on Unix platforms.

pub async fn watch_detached(&self, run_args: &[&str]) -> ServerManagerResult

Starts the server with hot-reloading using cargo-watch in detached mode.

This function spawns cargo-watch and returns immediately.

Arguments

• run_args - A slice of string arguments to pass to cargo-watch.

Returns

• ServerManagerResult - Operation result.

pub async fn watch(&self, run_args: &[&str]) -> ServerManagerResult

Starts the server with hot-reloading using cargo-watch and waits for it to complete.

This function is blocking and will wait for the cargo-watch process to exit.

Arguments

• run_args - A slice of string arguments to pass to cargo-watch.

Returns

• ServerManagerResult - Operation result.

Trait Implementations

impl Clone for ServerManager

fn clone(&self) -> ServerManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ServerManager

Provides a default implementation for ServerManager.

fn default() -> Self

Creates a default ServerManager instance with empty hooks and no PID file configured.