Chunkr.Cursor (Chunkr v0.2.0) View Source

Create and decode opaque, Base64-encoded cursors.

Link to this section Summary

Functions

Decode an opaque cursor.

Same as decode/1 but raises an error for invalid cursors.

Create an opaque, Base64-encoded cursor from cursor_values.

Link to this section Types

Specs

cursor_values() :: [any()]

Specs

opaque_cursor() :: binary()

Link to this section Functions

Specs

decode(opaque_cursor()) :: {:ok, cursor_values()} | {:error, any()}

Decode an opaque cursor.

Specs

decode!(opaque_cursor()) :: cursor_values() | none()

Same as decode/1 but raises an error for invalid cursors.

Specs

encode(cursor_values()) :: opaque_cursor()

Create an opaque, Base64-encoded cursor from cursor_values.