antikythera v0.3.0 Antikythera.Conn View Source

Updates an existing instance of Antikythera.Conn with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

Checks if the given value belongs to t/0 or not.

Link to this section Types

t()

t() :: %Antikythera.Conn{
  assigns: Antikythera.Conn.Assigns.t(),
  before_send: Antikythera.Conn.BeforeSend.t(),
  context: Antikythera.Context.t(),
  request: Antikythera.Request.t(),
  resp_body: Antikythera.Http.RawBody.t(),
  resp_cookies: Antikythera.Http.SetCookiesMap.t(),
  resp_headers: Antikythera.Http.Headers.t(),
  status: Croma.TypeGen.Nilable.Antikythera.Http.Status.Int.t()
}

Link to this section Functions

assign(conn, key, value)

assign(Antikythera.Conn.t(), atom(), any()) :: t()

assigns(conn)

assigns(t()) :: Antikythera.Conn.Assigns.t()

Type-aware getter for assigns.

assigns(s, field)

assigns(t(), Antikythera.Conn.Assigns.t()) :: t()

Type-aware setter for assigns.

before_send(conn)

before_send(t()) :: Antikythera.Conn.BeforeSend.t()

Type-aware getter for before_send.

before_send(s, field)

before_send(t(), Antikythera.Conn.BeforeSend.t()) :: t()

Type-aware setter for before_send.

clear_session(conn)

clear_session(Antikythera.Conn.t()) :: t()

context(conn)

context(t()) :: Antikythera.Context.t()

Type-aware getter for context.

context(s, field)

context(t(), Antikythera.Context.t()) :: t()

Type-aware setter for context.

delete_session(conn, key)

delete_session(Antikythera.Conn.t(), String.t()) :: t()

destroy_session(conn)

destroy_session(Antikythera.Conn.t()) :: t()

get_flash(arg0, key)

get_flash(Antikythera.Conn.t(), String.t()) :: nil | String.t()

Gets a flash message stored in the given Antikythera.Conn.t/0.

get_req_cookie(conn, name)

get_req_cookie(t(), String.t()) :: nil | String.t()

Returns a request cookie specified by name.

get_req_cookies(arg0)

get_req_cookies(Antikythera.Conn.t()) :: Antikythera.Http.ReqCookiesMap.t()

Returns all request cookies.

get_req_header(arg0, key)

get_req_header(Antikythera.Conn.t(), String.t()) :: nil | String.t()

get_req_query(arg0, key)

get_req_query(Antikythera.Conn.t(), String.t()) :: nil | String.t()

get_session(arg0, key)

get_session(Antikythera.Conn.t(), String.t()) :: any()

json(conn, status, body)

json(
  Antikythera.Conn.t(),
  Antikythera.Http.Status.t(),
  %{required(atom() | String.t()) => any()} | [any()]
) :: t()

Returns a JSON response.

new(dict)

new(term()) :: Croma.Result.t(t())

Creates a new instance of Antikythera.Conn by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

default/0 of each field type
new/1 of each field type, with empty map as input

new!(dict)

new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

no_cache(conn)

no_cache(t()) :: t()

Put cache-control response header for responses that must not be cached.

The actual header value to be set is: "private, no-cache, no-store, max-age=0".

put_flash(conn, key, value)

put_flash(Antikythera.Conn.t(), String.t(), String.t()) :: t()

Stores the flash message into the current Antikythera.Conn.t/0.

put_resp_body(conn, body)

put_resp_body(t(), String.t()) :: t()

put_resp_cookie(conn, name, value, opts0 \\ %{})

put_resp_cookie(
  Antikythera.Conn.t(),
  String.t(),
  String.t(),
  Antikythera.Http.SetCookie.options_t()
) :: t()

Adds a set-cookie response header to the given Antikythera.Conn.t.

path directive of set-cookie header is automatically filled with "/" if not explicitly given. Also secure directive is filled by default in the cloud environments (assuming that it's serving with HTTPS).

Note that response cookies are stored separately from the other response headers, as cookies require special treatment according to the HTTP specs.

put_resp_cookie_to_revoke(conn, name)

put_resp_cookie_to_revoke(t(), String.t()) :: t()

Tells the client to delete an existing cookie specified by name.

This is a wrapper around put_resp_cookie/4 that sets an immediately expiring cookie (whose value is an empty string).

put_resp_header(conn, key, value)

put_resp_header(Antikythera.Conn.t(), String.t(), String.t()) :: t()

put_resp_headers(conn, headers)

put_resp_headers(Antikythera.Conn.t(), %{required(String.t()) => String.t()}) ::
  t()

put_session(conn, key, value)

put_session(Antikythera.Conn.t(), String.t(), any()) :: t()

put_status(conn, status)

put_status(t(), Antikythera.Http.Status.t()) :: t()

redirect(conn, url, status \\ 302)

redirect(t(), String.t(), Antikythera.Http.Status.t()) :: t()

Returns an HTTP response that make the client redirect to the specified url.

register_before_send(conn, callback)

register_before_send(Antikythera.Conn.t(), (t() -> t())) :: t()

render(conn, status, template_name, render_params, opts \\ [layout: :application])

render(
  Antikythera.Conn.t(),
  Antikythera.Http.Status.t(),
  String.t(),
  Keyword.t(any()),
  Keyword.t(atom())
) :: t()

Renders a HAML template file and returns the dynamic content as an HTML response.

renew_session(conn)

renew_session(Antikythera.Conn.t()) :: t()

request(conn)

request(t()) :: Antikythera.Request.t()

Type-aware getter for request.

request(s, field)

request(t(), Antikythera.Request.t()) :: t()

Type-aware setter for request.

resp_body(conn)

resp_body(t()) :: Antikythera.Http.RawBody.t()

Type-aware getter for resp_body.

resp_body(s, field)

resp_body(t(), Antikythera.Http.RawBody.t()) :: t()

Type-aware setter for resp_body.

resp_cookies(conn)

resp_cookies(t()) :: Antikythera.Http.SetCookiesMap.t()

Type-aware getter for resp_cookies.

resp_cookies(s, field)

resp_cookies(t(), Antikythera.Http.SetCookiesMap.t()) :: t()

Type-aware setter for resp_cookies.

resp_headers(conn)

resp_headers(t()) :: Antikythera.Http.Headers.t()

Type-aware getter for resp_headers.

resp_headers(s, field)

resp_headers(t(), Antikythera.Http.Headers.t()) :: t()

Type-aware setter for resp_headers.

send_priv_file(conn, status, path)

send_priv_file(Antikythera.Conn.t(), Antikythera.Http.Status.t(), Path.t()) ::
  t()

Sends a file which resides in priv/ directory as a response.

path must be a file path relative to the priv/ directory. content-type header is inferred from the file's extension.

Don't use this function for sending large files; you should use CDN for large files (see Antikythera.Asset). Also, if all you need to do is just to return a file (i.e. you don't need any authentication), you should not use this function; just placing the file under priv/static/ directory should suffice.

status(conn)

status(t()) :: Croma.TypeGen.Nilable.Antikythera.Http.Status.Int.t()

Type-aware getter for status.

status(s, field)

status(t(), Croma.TypeGen.Nilable.Antikythera.Http.Status.Int.t()) :: t()

Type-aware setter for status.

update(s, dict)

update(t(), Dict.t()) :: Croma.Result.t(t())

update!(s, dict)

update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.