endpoint

Endpoint + middleware pipeline with controller and live-route dispatch.

Types

Endpoint

opaque

Endpoint definition.

pub opaque type Endpoint

Middleware

Endpoint middleware function.

pub type Middleware =
  fn(http.Conn) -> http.Conn

StaticAsset

One in-memory static asset served by this endpoint.

pub type StaticAsset {
  StaticAsset(path: String, content_type: String, body: String)
}

Constructors

StaticAsset(path: String, content_type: String, body: String)

Values

call

pub fn call(
  endpoint: Endpoint,
  request: http.Request,
) -> http.Response

Handle one request through middleware and dispatch tables.

get_controller

pub fn get_controller(
  endpoint: Endpoint,
  route: verified_routes.VerifiedRoute(params),
  run: fn(http.Conn) -> http.Conn,
) -> Endpoint

get_controller_indexed

pub fn get_controller_indexed(
  endpoint: Endpoint,
  route: verified_routes.IndexedRoute(
    params,
    verified_routes.GetTag,
  ),
  run: fn(http.Conn) -> http.Conn,
) -> Endpoint

get_live

pub fn get_live(
  endpoint: Endpoint,
  route: verified_routes.VerifiedRoute(params),
  view_id: String,
  render: fn(http.Conn) -> String,
) -> Endpoint

get_live_indexed

pub fn get_live_indexed(
  endpoint: Endpoint,
  route: verified_routes.IndexedRoute(
    params,
    verified_routes.GetTag,
  ),
  view_id: String,
  render: fn(http.Conn) -> String,
) -> Endpoint

new

pub fn new(
  auth_hook: contract.AuthHook,
  websocket_path: String,
) -> Endpoint

Create an endpoint.

pipe

pub fn pipe(
  endpoint: Endpoint,
  middleware: fn(http.Conn) -> http.Conn,
) -> Endpoint

route_labels

pub fn route_labels(endpoint: Endpoint) -> List(String)

Stable endpoint route table labels.

static

pub fn static(
  endpoint: Endpoint,
  path: String,
  content_type: String,
  body: String,
) -> Endpoint

static_labels

pub fn static_labels(endpoint: Endpoint) -> List(String)

Stable static table labels.