historian v0.11.0-beta.3 Historian.PageBuffer View Source

A buffer to manage paging your history... by "snapshotting" when the buffer was created.

Link to this section Summary

Types

page_result()

t()

Functions

current(pager)

first(pager)

get(pager, page_number)

get_line(pager, line_number)

handle_call(arg1, from, state)

handle_continue(atom, state)

info(pager)

init(page_size)

last(pager)

next(pager)

prev(pager)

set_page(pager, page)

start_link(page_size, opts \\ [])

Link to this section Types

page_result()

page_result() ::
  {:ok, Historian.History.t(Historian.History.Item.t())} | {:ok, :done}

t()

t() :: %Historian.PageBuffer{
  item_count: non_neg_integer(),
  offset: non_neg_integer(),
  page: non_neg_integer(),
  page_size: pos_integer(),
  ref: reference(),
  table: pos_integer(),
  total_pages: non_neg_integer()
}

Link to this section Functions

current(pager)

current(page_buffer_pid :: pid()) :: page_result()

first(pager)

first(page_buffer_pid :: pid()) :: page_result()

get(pager, page_number)

get(page_buffer_pid :: pid(), non_neg_integer()) :: page_result()

get_line(pager, line_number)

get_line(page_buffer_pid :: pid(), line_number :: non_neg_integer()) ::
  {:ok, Historian.History.Item.t() | nil}

handle_call(arg1, from, state)

handle_continue(atom, state)

info(pager)

info(page_buffer_pid :: pid()) :: t()

init(page_size)

last(pager)

last(page_buffer_pid :: pid()) :: page_result()

next(pager)

next(page_buffer_pid :: pid()) :: page_result()

prev(pager)

prev(page_buffer_pid :: pid()) :: page_result()

set_page(pager, page)

set_page(page_buffer_pid :: pid(), non_neg_integer()) :: page_result()

start_link(page_size, opts \\ [])