Crate essential_builder_api

The API for the Essential block builder.

Find the available endpoints under the endpoint module.

To serve the builder API, construct a router, a TcpListener and call serve.

Modules

endpoint

Provides a small module for each endpoint with associated PATH and handler.

Structs

ServeConnError

An error occurred while attempting to serve a connection.

State

State provided to the endpoints when serving connections.

Enums

ServeNextConnError

An error occurred while attempting to serve a new connection.

Constants

DEFAULT_CONNECTION_LIMIT

The default value used by essential-builder-cli for the maximum number of TCP stream connections to maintain at once.

Functions

cors_layer

The default CORS layer.

next_conn

Accept and return the next TCP stream connection.

router

Construct the endpoint router with the builder endpoints, CORS layer and DB connection pool as state.

serve

Continuously serve the Builder API using the given router and TCP listener.

serve_conn

Serve a newly accepted TCP stream.

serve_next_conn

Accept and serve the next connection.

with_endpoints

Add the builder API endpoints to the given router.