Struct Server 

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

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

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.

pub async fn new() -> Self

Creates a new Server instance with default settings.

Returns

• Self - A new Server instance.

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.

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

Handle a given hook macro asynchronously.

This function dispatches the provided HookMacro to the appropriate internal handler based on its HookType. Supported hook types include panic hooks, disable HTTP/WS hooks, connected hooks, pre-upgrade hooks, request/response middleware, and routes.

Arguments

• HookMacro: The HookMacro instance containing the HookType and its handler.

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.

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.

pub async fn panic_hook<F, Fut>(&self, hook: F) -> &Self

where F: FnContextSendSyncStatic<Fut, ()>, Fut: FutureSendStatic<()>,

Sets a custom panic hook for request processing.

Arguments

• F: FnContextSendSyncStatic<Fut, ()> - The panic handler function.
• Fut: FutureSendStatic<()> - The future returned by the panic handler.

Returns

• &Self - Reference to self for method chaining.

pub async fn route<R, F, Fut>(&self, route: R, hook: F) -> &Self

where R: ToString, F: FnContextSendSyncStatic<Fut, ()>, Fut: FutureSendStatic<()>,

Adds a route handler for a specific path.

Arguments

• R: ToString - The route path pattern.
• F: FnContextSendSyncStatic<Fut, ()> - The handler function for the route.
• Fut: FutureSendStatic<()> - The future returned by the handler.

Returns

• &Self - Reference to self for method chaining.

pub async fn request_middleware<F, Fut>(&self, hook: F) -> &Self

where F: FnContextSendSyncStatic<Fut, ()>, Fut: FutureSendStatic<()>,

Adds request middleware to the processing pipeline.

Arguments

• F: FnContextSendSyncStatic<Fut, ()> - The middleware function.
• Fut: FutureSendStatic<()> - The future returned by the middleware.

Returns

• &Self - Reference to self for method chaining.

pub async fn response_middleware<F, Fut>(&self, hook: F) -> &Self

where F: FnContextSendSyncStatic<Fut, ()>, Fut: FutureSendStatic<()>,

Adds response middleware to the processing pipeline.

Arguments

• F: FnContextSendSyncStatic<Fut, ()> - The middleware function.
• Fut: FutureSendStatic<()> - The future returned by the middleware.

Returns

• &Self - Reference to self for method chaining.

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

Formats the host and port into a bindable address string.

Arguments

• H: ToString - The host address.
• usize - The port number.

Returns

• String - The formatted address string.

pub async fn run(&self) -> ServerResult<ServerHook>

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 ServerResult 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.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Server

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

Formats the value using the given formatter.

impl Default for Server

fn default() -> Server

Returns the “default value” for a type.

impl Display for Server

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

Formats the value using the given formatter.

impl PartialEq for Server

Implements the PartialEq trait for Server.

This allows for comparing two Server instances for equality.

fn eq(&self, other: &Self) -> bool

Checks if two Server instances are equal.

Arguments

• &Self: The other Server instance to compare against.

Returns

• bool: true if the instances are equal, false otherwise.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Server

Implements the Eq trait for Server.

This indicates that Server has a total equality relation.