Trait trillium_server_common::Server

source ·
pub trait Server: Sized + Send + Sync + 'static {
    type Transport: Transport;

    const DESCRIPTION: &'static str;

    // Required methods
    fn accept(
        &mut self,
    ) -> Pin<Box<dyn Future<Output = Result<Self::Transport>> + Send + '_>>;
    fn info(&self) -> Info;
    fn spawn(fut: impl Future<Output = ()> + Send + 'static);
    fn block_on(fut: impl Future<Output = ()> + 'static);

    // Provided methods
    fn clean_up(self) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>> { ... }
    fn build_listener<A>(config: &Config<Self, A>) -> Self
       where A: Acceptor<Self::Transport> { ... }
    fn listener_from_tcp(_tcp: TcpListener) -> Self { ... }
    fn listener_from_unix(_tcp: UnixListener) -> Self { ... }
    fn handle_signals(
        _stopper: Stopper,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>> { ... }
    fn run<A, H>(config: Config<Self, A>, handler: H)
       where A: Acceptor<Self::Transport>,
             H: Handler { ... }
    fn run_async<A, H>(
        config: Config<Self, A>,
        handler: H,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>
       where A: Acceptor<Self::Transport>,
             H: Handler { ... }
}
Expand description

The server trait, for standard network-based server implementations.

Required Associated Types§

source

type Transport: Transport

the individual byte stream that http will be communicated over. This is often an async “stream” like TcpStream or UnixStream. See Transport

Required Associated Constants§

source

const DESCRIPTION: &'static str

The description of this server, to be appended to the Info and potentially logged.

Required Methods§

source

fn accept( &mut self, ) -> Pin<Box<dyn Future<Output = Result<Self::Transport>> + Send + '_>>

Asynchronously return a single Self::Transport from a Self::Listener. Must be implemented.

source

fn info(&self) -> Info

Build an Info from the Self::Listener type. See Info for more details.

source

fn spawn(fut: impl Future<Output = ()> + Send + 'static)

Runtime implementation hook for spawning a task.

source

fn block_on(fut: impl Future<Output = ()> + 'static)

Runtime implementation hook for blocking on a top level future.

Provided Methods§

source

fn clean_up(self) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>

After the server has shut down, perform any housekeeping, eg unlinking a unix socket.

source

fn build_listener<A>(config: &Config<Self, A>) -> Self
where A: Acceptor<Self::Transport>,

Build a listener from the config. The default logic for this is described elsewhere. To override the default logic, server implementations could potentially implement this directly. To use this default logic, implement Server::listener_from_tcp and Server::listener_from_unix.

source

fn listener_from_tcp(_tcp: TcpListener) -> Self

Build a Self::Listener from a tcp listener. This is called by the Server::build_listener default implementation, and is mandatory if the default implementation is used.

source

fn listener_from_unix(_tcp: UnixListener) -> Self

Build a Self::Listener from a tcp listener. This is called by the Server::build_listener default implementation. You will want to tag an implementation of this with #[cfg(unix)].

source

fn handle_signals( _stopper: Stopper, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>

Implementation hook for listening for any os signals and stopping the provided Stopper. The returned future will be spawned using Server::spawn

source

fn run<A, H>(config: Config<Self, A>, handler: H)
where A: Acceptor<Self::Transport>, H: Handler,

Run a trillium application from a sync context

source

fn run_async<A, H>( config: Config<Self, A>, handler: H, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>
where A: Acceptor<Self::Transport>, H: Handler,

Run a trillium application from an async context. The default implementation of this method contains the core logic of this Trait.

Object Safety§

This trait is not object safe.

Implementors§