Electric.Shapes.Api.Response (electric v1.1.1)

View Source

Summary

Types

shape_handle()
t()

Functions

electric_headers()
ensure_cleanup(response)
error(api_or_request, message, args \\ [])
etag(response, opts \\ [])
final(response)
invalid_request(api_or_request, args)
send(conn, response)
shape_definition_mismatch(request)

Types

shape_handle()

@type shape_handle() :: Electric.ShapeCacheBehaviour.shape_handle()

t()

@type t() :: %Electric.Shapes.Api.Response{
  api: Electric.Shapes.Api.t(),
  body: Enum.t(),
  chunked: boolean(),
  finalized?: term(),
  handle: nil | shape_handle(),
  known_error: term(),
  no_changes: boolean(),
  offset: nil | Electric.Replication.LogOffset.t(),
  params: Electric.Shapes.Api.Params.t(),
  shape_definition: nil | Electric.Shapes.Shape.t(),
  status: pos_integer(),
  trace_attrs: %{optional(atom()) => term()},
  up_to_date: boolean()
}

Functions

electric_headers()

ensure_cleanup(response)

error(api_or_request, message, args \\ [])

@spec error(
  Electric.Shapes.Api.t() | Electric.Shapes.Api.Request.t(),
  term(),
  keyword()
) :: t()

etag(response, opts \\ [])

final(response)

invalid_request(api_or_request, args)

send(conn, response)

@spec send(Plug.Conn.t(), t()) :: Plug.Conn.t()

shape_definition_mismatch(request)