request (slug.web)

slug.web.request

slug.web.request — HTTP request representation and parsing

Defines the Request struct and provides parsing, construction, and accessor functions for working with incoming HTTP requests.

Request struct fields

Header names are always normalised to lowercase. Access headers as req.headers["content-type"] not req.headers["Content-Type"].

TOC

• Request
• isRequest(x)
• parseRequestHeaders(buf)
• request(method, path, version, headers, body)
• shouldKeepAlive(req)
• withBody(req, body)
• withParams(request, params)
• withPath(req, path)
• withQuery(req, query)
• withoutParam(request, param)

Structs

Request

struct slug.web.request#Request{@str method, @str path, @str version, @map headers, body, @map query, @map form, @list files, @map params, requestId, traceId, spanId}

Functions

isRequest(x)

fn slug.web.request#isRequest(x) -> @bool

returns true if x is a Request struct instance.

parseRequestHeaders(buf)

fn slug.web.request#parseRequestHeaders(buf) -> [@struct(Request), @str]

parses the headers section of a raw HTTP request buffer.

Returns [Request, remainingBuffer] where remainingBuffer is the bytes after the \r\n\r\n header/body separator. The body is not read — the caller (the server) is responsible for reading it based on content-length and then calling withBody.

Header names are normalised to lowercase. Query string parameters are parsed and attached to req.query.

Throws RequestError if headers are incomplete or the request line is malformed.

Throws: @struct(Error{type:RequestError})

request(method, path, version, headers, body)

fn slug.web.request#request(method, path, version = "HTTP/1.1", headers = {}, body = "") -> @struct(Request)

constructs a new Request with the given method, path, and optional fields.

All other fields default to empty/nil. This is the canonical way to create a request for testing or manual construction.

shouldKeepAlive(req)

fn slug.web.request#shouldKeepAlive(req) -> @bool

returns true if the connection should be kept alive after this request.

For HTTP/1.0, keep-alive requires an explicit Connection: keep-alive header. For HTTP/1.1, keep-alive is the default unless Connection: close is set.

withBody(req, body)

fn slug.web.request#withBody(req, body) -> @struct(Request)

attaches a body to a request and parses form data if applicable.

If the content-type is application/x-www-form-urlencoded, the body is parsed and the result is available as req.form.

withParams(request, params)

fn slug.web.request#withParams(request, @map params) -> @struct(Request)

returns a new request with path params map replaced.

Used by the router to inject matched URL parameters (e.g. :id).

withPath(req, path)

fn slug.web.request#withPath(req, path) -> @struct(Request)

returns a new request with path replaced.

Used by the router to strip path prefixes for subrouters.

withQuery(req, query)

fn slug.web.request#withQuery(req, query) -> @struct(Request)

returns a new request with query replaced.

withoutParam(request, param)

fn slug.web.request#withoutParam(request, param) -> @struct(Request)

returns a new request with a single param key removed from params.

Used by subrouters to remove the "*" wildcard param after consuming it.