response

Types

Response

A HTTP response.

The body of the request is parameterised. The HTTP server or client you are using will have a particular set of types it supports for the body.

pub type Response(body) {
  Response(status: Int, headers: List(Header), body: body)
}

Constructors

```
Response(status: Int, headers: List(Header), body: body)
```
Arguments
- headers
  
  The request headers. The keys must always be lowercase.

Functions

expire_cookie

</>

pub fn expire_cookie(
  response: Response(a),
  name: String,
  attributes: Attributes,
) -> Response(a)

Expire a cookie value for a client

Note: The attributes value should be the same as when the response cookie was set.

get_cookies

</>

pub fn get_cookies(resp: Response(a)) -> List(#(String, String))

Fetch the cookies sent in a response.

Badly formed cookies will be discarded.

get_header

</>

pub fn get_header(
  response: Response(a),
  key: String,
) -> Result(String, Nil)

Get the value for a given header.

If the response does not have that header then Error(Nil) is returned.

map

</>

pub fn map(
  response: Response(a),
  transform: fn(a) -> b,
) -> Response(b)

Update the body of a response using a given function.

new

</>

pub fn new(status: Int) -> Response(String)

Construct an empty Response.

The body type of the returned response is String and could be set with a call to set_body.

prepend_header

</>

pub fn prepend_header(
  response: Response(a),
  key: String,
  value: String,
) -> Response(a)

Prepend the header with the given value under the given header key.

Similar to set_header except if the header already exists it prepends another header with the same key.

Header keys are always lowercase in gleam_http. To use any uppercase letter is invalid.

redirect

</>

pub fn redirect(uri: String) -> Response(String)

Create a response that redirects to the given uri.

set_body

</>

pub fn set_body(response: Response(a), body: b) -> Response(b)

Set the body of the response, overwriting any existing body.

set_cookie

</>

pub fn set_cookie(
  response: Response(a),
  name: String,
  value: String,
  attributes: Attributes,
) -> Response(a)

Set a cookie value for a client

set_header

</>

pub fn set_header(
  response: Response(a),
  key: String,
  value: String,
) -> Response(a)

Set the header with the given value under the given header key.

If the response already has that key, it is replaced.

Header keys are always lowercase in gleam_http. To use any uppercase letter is invalid.

try_map

</>

pub fn try_map(
  response: Response(a),
  transform: fn(a) -> Result(b, c),
) -> Result(Response(b), c)

Update the body of a response using a given result returning function.

If the given function returns an Ok value the body is set, if it returns an Error value then the error is returned.

Constructors

Arguments