Struct ServerBuilder 

pub struct ServerBuilder {}

Implementations

impl ServerBuilder

pub async fn serve( addr: SocketAddr, registry: Option<Registry>, cancellation_token: CancellationToken, ) -> Result<WithGracefulShutdown<IntoMakeService<Router>, Router, impl Future<Output = ()>>, Error>

Function that builds a new Metrics server and returns a WithGracefulShutdown instance ready to be spawn.

The available methods are:

• builder: Creates a new builder instance.
• addr: Sets the SocketAddr to bind the metrics server to.
• registry: Sets the Registry to use for metrics. (optional)
• build: Builds the metrics server and returns a WithGracefulShutdown instance.

Examples

async fn build_metrics() -> Result<(), Error> {
    ServerBuilder::builder()
        .addr("127.0.0.1".parse::<SocketAddr>().unwrap())
        .cancellation_token(CancellationToken::new())
        .build()
        .await?;

    Ok(())
}

Panics

Panics on failure of the gather_metrics internal methods (unlikely)

Errors

This function will return an error if the provided addr is invalid

impl ServerBuilder

pub fn builder() -> ServeServerBuilderBuilder

Function that builds a new Metrics server and returns a WithGracefulShutdown instance ready to be spawn.

The available methods are:

• builder: Creates a new builder instance.
• addr: Sets the SocketAddr to bind the metrics server to.
• registry: Sets the Registry to use for metrics. (optional)
• build: Builds the metrics server and returns a WithGracefulShutdown instance.

Examples

async fn build_metrics() -> Result<(), Error> {
    ServerBuilder::builder()
        .addr("127.0.0.1".parse::<SocketAddr>().unwrap())
        .cancellation_token(CancellationToken::new())
        .build()
        .await?;

    Ok(())
}

Panics

Panics on failure of the gather_metrics internal methods (unlikely)

Errors

This function will return an error if the provided addr is invalid