elixir_leaderboard

v0.1.5

elixir_leaderboard v0.1.5 ElixirLeaderboard.Record View Source

Record is the tuple-based structure that you get back when querying a leaderboard. In addition to the stored entry it also carries stats like rank and percentile.

Link to this section Summary

Types

entry_stats()

Any entry stats returned by the indexer

rank_stats()

Any rank stats returned by the indexer

t()

This is how each record comes back to you from the leaderboard. See below for breakdowns of each type

Functions

get_entry(arg)
get_stats(arg)

Link to this section Types

Link to this type

entry_stats() View Source 
entry_stats() :: term()

Any entry stats returned by the indexer.

Link to this type

rank_stats() View Source 
rank_stats() :: term()

Any rank stats returned by the indexer

Link to this type

t() View Source 
t() ::
  {ElixirLeaderboard.Entry.key(), ElixirLeaderboard.Entry.payload(),
   {entry_stats(), rank_stats()}}

This is how each record comes back to you from the leaderboard. See below for breakdowns of each type.

Link to this section Functions

Link to this function

get_entry(arg) View Source

Link to this function

get_stats(arg) View Source