Skip to content

http_server

class BuildableResponse

BuildableResponse¶

Build your own HTTP Responses (minus the body) and turn them into immutable things to send around.

This class can be serialized in the following ways:

to Array[U8]: BuildableResponse.array()
to ByteArrays: BuildableResponse.to_bytes()

or by using it as a ByteSeqIter.

This class exists if you want to use the verbose API of Session and brings lots of convenience, like getters and setters for all common properties.

If you are looking for a more efficient way to build responses, use a ResponseBuilder as it is returned from Responses.builder(), this class is not introspectable and only allows adding properties the way they are put on the serialized form in the request. E.g. you must first set the status and then the headers, not the other way around. But it makes for a more efficient API.

class val BuildableResponse is
  Response val,
  ByteSeqIter val

Implements¶

Response val
ByteSeqIter val

Constructors¶

create¶

new trn create(
  status': Status val = reference,
  version': ((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val) = reference)
: BuildableResponse trn^

Parameters¶

status': Status val = reference
version': ((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val) = reference

Returns¶

BuildableResponse trn^

Public Functions¶

version¶

fun box version()
: ((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val)

Returns¶

((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val)

set_version¶

fun ref set_version(
  v: ((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val))
: BuildableResponse ref

Parameters¶

v: ((HTTP09 val | HTTP10 val | HTTP11 val) & _Version val)

Returns¶

BuildableResponse ref

status¶

fun box status()
: Status val

Returns¶

Status val

set_status¶

fun ref set_status(
  s: Status val)
: BuildableResponse ref

Parameters¶

s: Status val

Returns¶

BuildableResponse ref

fun box header(
  name: String val)
: (String val | None val)

Parameters¶

name: String val

Returns¶

(String val | None val)

headers¶

fun box headers()
: Iterator[(String val , String val)] ref

Returns¶

Iterator[(String val , String val)] ref

add_header¶

fun ref add_header(
  name: String val,
  value: String val)
: BuildableResponse ref

Parameters¶

name: String val
value: String val

Returns¶

BuildableResponse ref

set_header¶

fun ref set_header(
  name: String val,
  value: String val)
: BuildableResponse ref

Parameters¶

name: String val
value: String val

Returns¶

BuildableResponse ref

delete_header¶

fun ref delete_header(
  name: String val)
: BuildableResponse ref

Parameters¶

name: String val

Returns¶

BuildableResponse ref

clear_headers¶

fun ref clear_headers()
: BuildableResponse ref

Returns¶

BuildableResponse ref

transfer_encoding¶

fun box transfer_encoding()
: (Chunked val | None val)

Returns¶

(Chunked val | None val)

set_transfer_encoding¶

fun ref set_transfer_encoding(
  c: (Chunked val | None val))
: BuildableResponse ref

Parameters¶

c: (Chunked val | None val)

Returns¶

BuildableResponse ref

content_length¶

fun box content_length()
: (USize val | None val)

Returns¶

(USize val | None val)

set_content_length¶

Set or un-set the Content-Length header.

fun ref set_content_length(
  cl: (USize val | None val))
: BuildableResponse ref

Parameters¶

cl: (USize val | None val)

Returns¶

BuildableResponse ref

array¶

fun box array()
: Array[U8 val] iso^

Returns¶

Array[U8 val] iso^

to_bytes¶

fun box to_bytes()
: ByteArrays val

Returns¶

ByteArrays val

values¶

Make this a very inefficient ByteSeqIter. Rather use array() if you care about performance.

fun box values()
: Iterator[(this->String box | this->Array[U8 val] box)] ref

Returns¶

Iterator[(this->String box | this->Array[U8 val] box)] ref