Grouper v0.1.0

Grouper.Data.Group (Grouper v0.1.0) View Source

data layer driver for explicitly-created groups

Link to this section Summary

Types

group_pid()
group_tid()
key()
meta()
type()
value()

Functions

del(meta, type, key)

delete data value of a given type and a given key

enum(arg, type)

enumerates all key-values of a given type

get(arg, type, key)

get data value of a given type and a given key

init(meta, opts)

initialize group-driven data

put(meta, type, key, val)

store data value of a given type and a given key

Link to this section Types

Link to this type

group_pid()

View Source

Specs

group_pid() :: pid()
Link to this type

group_tid()

View Source

Specs

group_tid() :: atom()
Link to this type

key()

View Source

Specs

key() :: Grouper.Data.key()
Link to this type

meta()

View Source

Specs

meta() :: {group_pid(), group_tid()}
Link to this type

type()

View Source

Specs

type() :: Grouper.Data.type()
Link to this type

value()

View Source

Specs

value() :: Grouper.Data.value()

Link to this section Functions

Link to this function

del(meta, type, key)

View Source

Specs

del(meta(), type(), key()) :: value() | nil

delete data value of a given type and a given key

Link to this function

enum(arg, type)

View Source

Specs

enum(meta(), type()) :: [{{type(), key()}, value()}] | [{key(), value()}]

enumerates all key-values of a given type

Specify the special type :_ to read data of all types

Link to this function

get(arg, type, key)

View Source

Specs

get(meta(), type(), key()) :: value() | nil

get data value of a given type and a given key

Link to this function

init(meta, opts)

View Source

Specs

init(meta(), opts :: keyword()) :: :ok

initialize group-driven data

Currently does nothing.

Link to this function

put(meta, type, key, val)

View Source

Specs

put(meta(), type(), key(), value()) :: value() | nil

store data value of a given type and a given key