Struct ServerConfig 

pub struct ServerConfig { /* private fields */ }

This struct represents the shared configuration and context for a http server.

This currently contains tunable parameters in a HttpConfig, the Swansong graceful shutdown control interface, and a shared TypeSet that contains application-specific information about the running server

Implementations

impl ServerConfig

pub fn http_config(&self) -> &HttpConfig

Borrows HttpConfig performance and security parameters

pub fn http_config_mut(&mut self) -> &mut HttpConfig

Mutably borrow HttpConfig performance and security parameters

pub fn set_http_config(&mut self, http_config: HttpConfig) -> &mut Self

Sets HttpConfig performance and security parameters, returning &mut Self for chaining

pub fn with_http_config(self, http_config: HttpConfig) -> Self

Owned chainable setter for HttpConfig performance and security parameters, returning Self

pub fn swansong(&self) -> &Swansong

Borrows Swansong graceful shutdown interface

pub fn swansong_mut(&mut self) -> &mut Swansong

Mutably borrow Swansong graceful shutdown interface

pub fn set_swansong(&mut self, swansong: Swansong) -> &mut Self

Sets Swansong graceful shutdown interface, returning &mut Self for chaining

pub fn with_swansong(self, swansong: Swansong) -> Self

Owned chainable setter for Swansong graceful shutdown interface, returning Self

pub fn shared_state(&self) -> &TypeSet

Borrows TypeSet shared state

pub fn shared_state_mut(&mut self) -> &mut TypeSet

Mutably borrow TypeSet shared state

pub fn set_shared_state(&mut self, shared_state: TypeSet) -> &mut Self

Sets TypeSet shared state, returning &mut Self for chaining

pub fn with_shared_state(self, shared_state: TypeSet) -> Self

Owned chainable setter for TypeSet shared state, returning Self

impl ServerConfig

pub fn new() -> Self

Construct a new ServerConfig

pub async fn run<Transport, Handler, Fut>( self: Arc<Self>, transport: Transport, handler: Handler, ) -> Result<Option<Upgrade<Transport>>>

where Transport: AsyncRead + AsyncWrite + Unpin + Send + Sync + 'static, Handler: FnMut(Conn<Transport>) -> Fut, Fut: Future<Output = Conn<Transport>>,

Perform HTTP on the provided transport, applying the provided async Conn -> Conn handler function for every distinct http request-response.

For any given invocation of ServerConfig::run, the handler function may run any number of times, depending on whether the connection is reused by the client.

This can only be called on an Arc<ServerConfig> because an arc clone is moved into the Conn.

Errors

This function will return an Error if any of the http requests is irrecoverably malformed or otherwise noncompliant.

pub fn shut_down(&self) -> ShutdownCompletion

Attempt graceful shutdown of this server.

The returned ShutdownCompletion type can either be awaited in an async context or blocked on with ShutdownCompletion::block in a blocking context

Trait Implementations

impl AsMut<TypeSet> for ServerConfig

fn as_mut(&mut self) -> &mut TypeSet

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<HttpConfig> for ServerConfig

fn as_ref(&self) -> &HttpConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Swansong> for ServerConfig

fn as_ref(&self) -> &Swansong

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<TypeSet> for ServerConfig

fn as_ref(&self) -> &TypeSet

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> ServerConfig

Returns the “default value” for a type.