Spaceboy v0.1.1

Spaceboy.Header (Spaceboy v0.1.1) View Source

Struct representing Gemini header response.

You should not create headers directly - all supported headers has functions with correct codes.

Link to this section Summary

Types

t()

Input

input(prompt)
sensitive_input(prompt)

Success

success(mime \\ "text/gemini; charset=utf-8")

Redirect

permanent_redirect(dest)
redirect(dest)
temporary_redirect(dest)

Temporary Failure

cgi_error(reason)
proxy_error(reason)
server_unavailable(reason)
slow_down(wait_time \\ 60)
temporary_failure(reason)

Permanent Failure

bad_request(desc)
gone(desc)
not_found(desc)
permanent_failure(desc)
proxy_request_refused(desc)

Client Certificate Required

certificate_not_authorised(prompt)
certificate_not_valid(prompt)
client_certificate_required(prompt)

Utils

format(header)

Correctly format the response header

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Spaceboy.Header{code: pos_integer(), meta: String.t() | pos_integer()}

Link to this section Input

Link to this function

input(prompt)

View Source

Specs

input(prompt :: String.t()) :: t()
Link to this function

sensitive_input(prompt)

View Source

Specs

sensitive_input(prompt :: String.t()) :: t()

Link to this section Success

Link to this function

success(mime \\ "text/gemini; charset=utf-8")

View Source

Specs

success(mime :: String.t()) :: t()

Link to this section Redirect

Link to this function

permanent_redirect(dest)

View Source

Specs

permanent_redirect(dest :: String.t()) :: t()
Link to this function

redirect(dest)

View Source

Specs

redirect(dest :: String.t()) :: t()
Link to this function

temporary_redirect(dest)

View Source

Specs

temporary_redirect(dest :: String.t()) :: t()

Link to this section Temporary Failure

Link to this function

cgi_error(reason)

View Source

Specs

cgi_error(reason :: String.t()) :: t()
Link to this function

proxy_error(reason)

View Source

Specs

proxy_error(reason :: String.t()) :: t()
Link to this function

server_unavailable(reason)

View Source

Specs

server_unavailable(reason :: String.t()) :: t()
Link to this function

slow_down(wait_time \\ 60)

View Source

Specs

slow_down(wait_time :: pos_integer()) :: t()
Link to this function

temporary_failure(reason)

View Source

Specs

temporary_failure(reason :: String.t()) :: t()

Link to this section Permanent Failure

Link to this function

bad_request(desc)

View Source

Specs

bad_request(desc :: String.t()) :: t()
Link to this function

gone(desc)

View Source

Specs

gone(desc :: String.t()) :: t()
Link to this function

not_found(desc)

View Source

Specs

not_found(desc :: String.t()) :: t()
Link to this function

permanent_failure(desc)

View Source

Specs

permanent_failure(desc :: String.t()) :: t()
Link to this function

proxy_request_refused(desc)

View Source

Specs

proxy_request_refused(desc :: String.t()) :: t()

Link to this section Client Certificate Required

Link to this function

certificate_not_authorised(prompt)

View Source

Specs

certificate_not_authorised(prompt :: String.t()) :: t()
Link to this function

certificate_not_valid(prompt)

View Source

Specs

certificate_not_valid(prompt :: String.t()) :: t()
Link to this function

client_certificate_required(prompt)

View Source

Specs

client_certificate_required(prompt :: String.t()) :: t()

Link to this section Utils

Link to this function

format(header)

View Source

Specs

format(header :: t()) :: String.t()

Correctly format the response header

Examples 

iex> "Test input" |> Spaceboy.Header.input() |> Spaceboy.Header.format()
"10 Test input\r\n"

iex> Spaceboy.Header.success() |> Spaceboy.Header.format()
"20 text/gemini; charset=utf-8\r\n"