Flop v0.6.0 Flop.Meta View Source

Defines a struct for holding meta information of a query result.

Link to this section Summary

Types

t()

Meta information for a query result.

Link to this section Types

Specs

t() :: %Flop.Meta{
  current_offset: non_neg_integer(),
  current_page: pos_integer(),
  has_next_page?: boolean(),
  has_previous_page?: boolean(),
  next_offset: non_neg_integer() | nil,
  next_page: pos_integer() | nil,
  page_size: pos_integer() | nil,
  previous_offset: non_neg_integer() | nil,
  previous_page: pos_integer() | nil,
  total_count: non_neg_integer(),
  total_pages: non_neg_integer()
}

Meta information for a query result.