moonbitstack/moonasgi/conform

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/conform does not have a README file

ConformanceReport

pub(all) struct ConformanceReport {
  total : Int
  passed : Int
  failures : Array[String]
} derive(Eq)

The outcome of the ASGI 3.0 conformance harness: how many round-trip checks ran, how many passed, and the names of any that failures. A clean run has an empty failures. Reusable beyond the test suite — a server or framework built on the seam can call run_conformance to self-verify the wiring.

ConformanceReport::equal

source

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

ConformanceReport::not_equal

source

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

ConformanceReport::ok

source

fn ConformanceReport::ok(self : ConformanceReport) -> Bool

Whether every conformance check passed (no failures recorded).

EventOrderError

source

pub(all) enum EventOrderError {
  BodyBeforeStart
  DuplicateResponseStart
  EarlyHintAfterStart
  BodyAfterComplete
  UnexpectedTrailers
  TrailersBeforeBody
  MissingResponseStart
  IncompleteBody
  MissingTrailers
  EventAfterComplete
  DebugAfterStart
  DuplicateDebug
  PushBeforeStart
  PathSendMixedWithBody
  IllegalResponseHeader
  FrameBeforeAccept
  DuplicateAccept
  EventAfterClose
  DenialBodyBeforeStart
  DenialAfterAccept
  AcceptAfterDenial
  IncompleteDenial
  MissingHandshakeReply
  DuplicateLifespanReply
  ShutdownBeforeStartup
  NonResponseEvent
} derive(Eq)

Why an outbound event stream is malformed. ASGI pins the order an application may emit messages in — a body before the response starts, a second start, a websocket frame before the handshake is accepted, and so on are all protocol violations. validate_events walks a stream and names the first violation it finds; a well-formed stream returns None. A server can run this over its own emissions to catch a buggy app early, and the conformance harness drives a negative table through it.

EventOrderError::describe

source

fn EventOrderError::describe(self : EventOrderError) -> String

A one-line human description of the violation, used in conformance failure names and server logs.

EventOrderError::equal

source

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

EventOrderError::not_equal

source

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

run_conformance

source

fn run_conformance() -> ConformanceReport

Run the ASGI 3.0 conformance harness: a table-driven battery that drives every @spec.Event variant and every Scope field through @http.run_http, ws_run, and the @client.TestClient, asserting round-trip fidelity — a value put in comes back unchanged, and no two distinct events or scope shapes are confused — and a negative table that asserts validate_events rejects every malformed ordering (a body before the response starts, a websocket frame before the handshake, a lifespan shutdown reply before startup, and the rest) with the exact violation. Returns a ConformanceReport naming any check that failed, so the suite (and any downstream server) can assert ok().

validate_events

source

fn validate_events(scope : @moonbitstack/moonasgi/spec.Scope
Scope, events : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> EventOrderError?

Validate an outbound event stream against the ordering rules for its scope, dispatching to the http / websocket / lifespan validator. The public entry a server calls to check an application's emissions before writing them to the wire.

validate_http_response

source

fn validate_http_response(events : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> EventOrderError?

Validate the outbound event stream an application emits for an http request, against ASGI's http response ordering: at most one HttpResponseStart, no body or pathsend/zerocopysend before it, early hints only ahead of it, a body stream that terminates once (more_body: false), trailers only when the start promised them and only after the body completes, and nothing after the response is fully sent. HttpResponseDebug must come once and before the start; HttpResponsePush only after it; HttpResponsePathSend cannot be mixed with a body. Returns the first violation, or None for a well-formed complete response.

validate_inbound

source

fn validate_inbound(event : @moonbitstack/moonasgi/spec.Event
Event) -> EventOrderError?

Check an inbound event an application is about to act on. ASGI requires exactly one of bytes or text to be set on a websocket.receive, and a frame that sets neither, or both, is a server bug the application should not have to guess about. Returns None for a well-formed event.

validate_lifespan_replies

source

fn validate_lifespan_replies(events : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> EventOrderError?

Validate the outbound replies an application emits for a lifespan run: a startup reply (LifespanStartupComplete / LifespanStartupFailed) before a shutdown reply (LifespanShutdownComplete / LifespanShutdownFailed), each phase answered at most once. Returns the first violation, or None.

validate_ws_response

source

fn validate_ws_response(events : Array[@moonbitstack/moonasgi/spec.Event
Event]) -> EventOrderError?

Validate the outbound event stream an application emits for a websocket connection, against ASGI's handshake ordering: the connect must be answered with an WebSocketAccept, a WebSocketClose, or a denial (WebSocketHttpResponseStart + body); frames are only legal once accepted; nothing follows a close or a completed denial; a denial cannot mix with an accept. Returns the first violation, or None for a well-formed stream.