Struct Server

Source

pub struct Server(/* private fields */);

Expand description

The primary server structure that provides a thread-safe interface to the server’s state.

This struct acts as a public-facing wrapper around an Arc<RwLock<ServerInner>>. It allows multiple parts of the application to safely share and modify the server’s configuration and state across different threads and asynchronous tasks.

Implementations§

Source §

impl Server

Represents the server, providing methods to configure and run it.

This struct wraps the ServerInner configuration and routing logic, offering a high-level API for setting up the HTTP and WebSocket server.

Source

pub async fn new() -> Self

Creates a new Server instance with default settings.

§Returns

Self - A new Server instance.

Source

pub async fn from(config: ServerConfig) -> Self

Creates a new Server instance from a configuration.

§Arguments

ServerConfig - The server configuration.

§Returns

Self - A new Server instance.

Source

pub async fn get_route_matcher(&self) -> RouteMatcher

Gets the route matcher.

§Returns

RouteMatcher - The route matcher.

Source

pub async fn handle_hook(&self, hook: HookType)

Registers a hook into the server’s processing pipeline.

This function dispatches the provided HookType to the appropriate internal hook collection based on its variant. The hook will be executed at the corresponding stage of request processing according to its type:

Panic: Added to panic handlers for error recovery
RequestError: Added to request error handlers
RequestMiddleware: Added to pre-route middleware chain
Route: Registered as a route handler for the specified path
ResponseMiddleware: Added to post-route middleware chain

§Arguments

HookType - The HookType instance containing the hook configuration and factory.

Source

pub async fn config_str<C: ToString>(&self, config_str: C) -> &Self

Sets the server configuration from a string.

§Arguments

C: ToString - The configuration.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn config(&self, config: ServerConfig) -> &Self

Sets the server configuration.

§Arguments

ServerConfig - The server configuration.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn task_panic<S>(&self) -> &Self
where S: ServerHook,

Registers a task panic handler to the processing pipeline.

This method allows registering task panic handlers that implement the ServerHook trait, which will be executed when a panic occurs during request processing.

§Type Parameters

ServerHook - The task panic handler type that implements ServerHook.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn request_error<S>(&self) -> &Self
where S: ServerHook,

Registers a request error handler to the processing pipeline.

This method allows registering request error handlers that implement the ServerHook trait, which will be executed when a request error occurs during HTTP request processing.

§Type Parameters

ServerHook - The request error handler type that implements ServerHook.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn route<S>(&self, path: impl ToString) -> &Self
where S: ServerHook,

Registers a route hook for a specific path.

This method allows registering route handlers that implement the ServerHook trait, providing type safety and better code organization.

§Type Parameters

ServerHook - The route hook type that implements ServerHook.

§Arguments

path - The route path pattern.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn request_middleware<S>(&self) -> &Self
where S: ServerHook,

Registers request middleware to the processing pipeline.

This method allows registering middleware that implements the ServerHook trait, which will be executed before route handlers for every incoming request.

§Type Parameters

ServerHook - The middleware type that implements ServerHook.

§Returns

&Self - Reference to self for method chaining.

Source

pub async fn response_middleware<S>(&self) -> &Self
where S: ServerHook,

Registers response middleware to the processing pipeline.

This method allows registering middleware that implements the ServerHook trait, which will be executed after route handlers for every outgoing response.

§Type Parameters

ServerHook - The middleware type that implements ServerHook.

§Returns

&Self - Reference to self for method chaining.

Source

pub fn format_host_port<H: ToString>(host: H, port: u16) -> String

Formats the host and port into a bindable address string.

§Arguments

H: ToString - The host address.
u16 - The port number.

§Returns

String - The formatted address string.

Source

pub fn try_flush_stdout() -> Result<()>

Flushes the standard output stream.

§Returns

io::Result<()> - The result of the flush operation.

Source

pub fn flush_stdout()

Flushes the standard error stream.

§Panics

This function will panic if the flush operation fails.

Source

pub fn try_flush_stderr() -> Result<()>

Flushes the standard error stream.

§Returns

io::Result<()> - The result of the flush operation.

Source

pub fn flush_stderr()

Flushes the standard error stream.

§Panics

This function will panic if the flush operation fails.

Source

pub fn try_flush_stdout_and_stderr() -> Result<()>

Flushes both the standard output and error streams.

§Returns

io::Result<()> - The result of the flush operation.

Source

pub fn flush_stdout_and_stderr()

Flushes both the standard output and error streams.

§Panics

This function will panic if either flush operation fails.

Source

pub async fn handle_request_error(&self, ctx: &Context, error: &RequestError)

Handles errors that occur while processing HTTP requests.

§Arguments

&Context - The request context.
&RequestError - The error that occurred.

Source

pub async fn run(&self) -> Result<ServerControlHook, ServerError>

Starts the server, binds to the configured address, and begins listening for connections.

This is the main entry point to launch the server. It will initialize the panic hook, create a TCP listener, and then enter the connection acceptance loop in a background task.

§Returns

Returns a Result containing a shutdown function on success. Calling this function will shut down the server by aborting its main task. Returns an error if the server fails to start.