radiant/request

Request accessors, context keys, and request errors.

Types

Key

opaque </>

A typed key for the request context.

pub opaque type Key(a)

RadiantError

</>

Errors returned by request and context accessors.

pub type RadiantError {
  MissingHeader(String)
  InvalidUtf8Body
  MissingPathParam(String)
  InvalidIntParam(String, String)
  MissingQuery(String)
  InvalidIntQuery(String, String)
  InvalidFloatQuery(String, String)
  InvalidBoolQuery(String, String)
  MalformedQuery(String)
  MissingContext(String)
}

Constructors

```
MissingHeader(String)
```
```
InvalidUtf8Body
```
```
MissingPathParam(String)
```
```
InvalidIntParam(String, String)
```
```
MissingQuery(String)
```
```
InvalidIntQuery(String, String)
```
```
InvalidFloatQuery(String, String)
```
```
InvalidBoolQuery(String, String)
```
```
MalformedQuery(String)
```
```
MissingContext(String)
```

Req

opaque </>

Opaque request wrapper with the original request, path params, and typed context.

pub opaque type Req

Values

body

</>

pub fn body(req: Req) -> BitArray

The raw request body.

from_request

</>

pub fn from_request(request: request.Request(BitArray)) -> Req

Low-level helper used by radiant/router to wrap an HTTP request.

get_context

</>

pub fn get_context(
  req: Req,
  k: Key(a),
) -> Result(a, RadiantError)

Retrieve a typed value from the request context.

</>

pub fn header(
  req: Req,
  key: String,
) -> Result(String, RadiantError)

Get a request header by key.

headers

</>

pub fn headers(req: Req) -> List(#(String, String))

All request headers.

int_param

</>

pub fn int_param(
  req: Req,
  name: String,
) -> Result(Int, RadiantError)

Extract a path parameter as Int.

key

</>

pub fn key(name: String) -> Key(a)

Create a typed context key.

key_named

</>

pub fn key_named(namespace: String, name: String) -> Key(a)

Create a typed context key with an explicit namespace.

method

</>

pub fn method(req: Req) -> http.Method

The request HTTP method.

original

</>

pub fn original(req: Req) -> request.Request(BitArray)

Access the underlying Request(BitArray).

queries

</>

pub fn queries(req: Req) -> List(#(String, String))

All query parameters.

query

</>

pub fn query(
  req: Req,
  key: String,
) -> Result(String, RadiantError)

Get a single query parameter by key.

query_bool

</>

pub fn query_bool(
  req: Req,
  key: String,
) -> Result(Bool, RadiantError)

Get a query parameter parsed as Bool.

query_float

</>

pub fn query_float(
  req: Req,
  key: String,
) -> Result(Float, RadiantError)

Get a query parameter parsed as Float.

query_int

</>

pub fn query_int(
  req: Req,
  key: String,
) -> Result(Int, RadiantError)

Get a query parameter parsed as Int.

req_path

</>

pub fn req_path(req: Req) -> String

The request path.

set_context

</>

pub fn set_context(req: Req, k: Key(a), value: a) -> Req

Store a typed value in the request context.

str_param

</>

pub fn str_param(
  req: Req,
  name: String,
) -> Result(String, RadiantError)

Extract a path parameter as String.

text_body

</>

pub fn text_body(req: Req) -> Result(String, RadiantError)

The request body decoded as UTF-8 text.

with_method

</>

pub fn with_method(req: Req, method: http.Method) -> Req

Low-level helper used by radiant/router for HEAD-to-GET dispatch.

with_params

</>

pub fn with_params(
  req: Req,
  params: dict.Dict(String, String),
) -> Req

Low-level helper used by radiant/router to attach extracted path params.