moonbitstack/moonasgi/lifespan

README
U
AsgiApp
U
AsgiAppInstance
U
AsgiApplication
U
AsgiVersion
U
ConformanceReport
U
Drain
U
Event
U
EventOrderError
U
Extensions
U
Handler
U
Http2HeaderError
U
HttpScope
U
LegacyAsgiApp
U
LifespanHandler
U
LifespanReply
U
LifespanScope
U
Middleware
U
PushPromise
U
Receive
U
Request
U
Response
U
Scope
U
Send
U
StreamHandler
U
StreamingResponse
U
TestClient
U
TestResponse
U
TlsExtension
U
WebSocketHandler
U
WebSocketScope
U
WsAccept
U
WsMessage
U
WsSend
U
WsTestSession
U
ZeroCopySend
V
compose
V
double_to_single_callable
V
guarantee_single_callable
V
headers_from_wire
V
headers_to_wire
V
latin1_decode
V
latin1_encode
V
percent_decode
V
run_conformance
V
run_http
V
run_http_app
V
run_http_scoped
V
run_http_scoped_drain
V
run_http_stream
V
run_legacy
V
run_lifespan
V
to_asgi
V
validate_events
V
validate_http_response
V
validate_inbound
V
validate_lifespan_replies
V
validate_ws_response
V
ws_run
V
ws_run_app

moonbitstack/moonasgi/lifespan does not have a README file

LifespanHandler

pub(all) struct LifespanHandler {
  on_startup : (@moonbitstack/moonasgi/spec.LifespanScope
LifespanScope) -> LifespanReply
  on_shutdown : (@moonbitstack/moonasgi/spec.LifespanScope
LifespanScope) -> LifespanReply
}

A synchronous lifespan application in the startup / shutdown shape, the lifespan analog of the http Handler and the WebSocket WebSocketHandler. on_startup runs once at boot: it seeds the scope's state in place (the map the server then copies onto every request scope — a DB pool handle, a loaded config) and returns Complete or Failed. on_shutdown runs once at teardown to release those resources. Driven in-process by run_lifespan, so boot/teardown logic is testable on every backend without an async runtime — the faithful synchronous core the async server (mooncat) lifts onto the lifespan protocol.

LifespanHandler::new

source

fn LifespanHandler::new(on_startup? : (@moonbitstack/moonasgi/spec.LifespanScope
LifespanScope) -> LifespanReply, on_shutdown? : (@moonbitstack/moonasgi/spec.LifespanScope
LifespanScope) -> LifespanReply) -> LifespanHandler

Build a LifespanHandler. Both phases default to succeeding without doing anything, so a caller overrides only the phase it needs — an app that just wants a startup hook leaves on_shutdown alone.

LifespanReply

source

pub(all) enum LifespanReply {
  Complete
  Failed(message~ : String)
} derive(Eq)

An application's answer to a lifespan phase: Complete when startup or shutdown succeeded, or Failed with a message the server logs and (for startup) aborts the boot on. Mirrors the two replies ASGI allows to each lifespan message — lifespan.startup.complete / .failed and lifespan.shutdown.complete / .failed.

LifespanReply::equal

source

fn LifespanReply::equal(LifespanReply, LifespanReply) -> Bool

LifespanReply::not_equal

source

fn LifespanReply::not_equal(x : LifespanReply, y : LifespanReply) -> Bool

run_lifespan

source

fn run_lifespan(handler : LifespanHandler, scope : @moonbitstack/moonasgi/spec.Scope
Scope, inbound : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> Array[@moonbitstack/moonasgi/spec.Event
Event]

Drive a LifespanHandler over a materialised inbound event stream, folding it into the outbound replies a server would send. LifespanStartup runs on_startup and emits LifespanStartupComplete or LifespanStartupFailed; a failed startup ends the run, since ASGI has the server abort the boot and never send lifespan.shutdown. LifespanShutdown runs on_shutdown and emits the matching shutdown reply. The handler mutates scope.state in place during startup, exactly as an ASGI app populates scope["state"]. This is the synchronous lifespan core mirroring run_http / ws_run; a non-lifespan scope yields [].