Runlet.State (runlet v1.2.7)

Persistent state storage for processes

Summary

Functions

add(type, id, key, val)

Add key/value to user state file.

add(dir, type, id, key, val)

char_reserved?(char)

Characters escaped by percent encoding. Allows @.

decode(user)

Decode identifier from percent encoding.

delete(type, id, key)

Remove key in user's state file.

delete(dir, type, id, key)

encode(user)

Percent encode identifier in a filesystem safe format.

exists?(id)

Test if a state dir for a user exists.

exists?(type, id)

Test if a given state file exists for a user.

path()

Storage location for runlet state.

table(type, id)

Lists all entries in a state file for a user.

table(dir, type, id)

Functions

add(type, id, key, val)

@spec add(String.t(), String.t(), any(), any()) :: :ok | {:error, any()}

Add key/value to user state file.

add(dir, type, id, key, val)

char_reserved?(char)

@spec char_reserved?(byte()) :: boolean()

Characters escaped by percent encoding. Allows @.

decode(user)

@spec decode(binary()) :: binary()

Decode identifier from percent encoding.

delete(type, id, key)

@spec delete(String.t(), String.t(), any()) :: :ok | {:error, any()}

Remove key in user's state file.

delete(dir, type, id, key)

encode(user)

@spec encode(binary()) :: binary()

Percent encode identifier in a filesystem safe format.

exists?(id)

@spec exists?(String.t()) :: boolean()

Test if a state dir for a user exists.

exists?(type, id)

@spec exists?(String.t(), String.t()) :: boolean()

Test if a given state file exists for a user.

path()

@spec path() :: binary()

Storage location for runlet state.

table(type, id)

@spec table(String.t(), String.t()) :: [tuple()]

Lists all entries in a state file for a user.

table(dir, type, id)

@spec table(binary(), String.t(), String.t()) :: [tuple()]