phasedb v0.0.2 PhaseDB.Cursor protocol

Implements the basic API for dealing with series cursors (basically connections to various storage systems).

To implement a storage system for PhaseDB you need to implement the following protocols:

Also, if you implement Enumerable you'll find it easier to debug.

Summary

t()

Returns true if the cursor refers to a working storage system

Remove this cursor's storage system

Return the range of the series

Return the resolution of the series

t :: Cursor.t

alive?(cursor)

alive?(t) :: boolean

Returns true if the cursor refers to a working storage system

drop(cursor)

drop(t) :: :ok

Remove this cursor's storage system

range(cursor)

range(t) :: non_neg_integer | nil

Return the range of the series

resolution(cursor)

resolution(t) :: non_neg_integer

Return the resolution of the series