ets v0.8.0 ETS.KeyValueSet View Source

The Key Value Set is an extension of ETS.Set which abstracts the concept of tuple records away, replacing it with the standard concept of key/value. Behind the scenes, the set stores its records as {key, value}.

Examples

iex> {:ok, kvset} = KeyValueSet.new()
iex> KeyValueSet.put(kvset, :my_key, :my_val)
iex> KeyValueSet.get(kvset, :my_key)
{:ok, :my_val}

KeyValueSet implements [Access] behaviour.

Examples

iex> set =
...>   KeyValueSet.new!()
...>   |> KeyValueSet.put!(:k1, :v1)
...>   |> KeyValueSet.put!(:k2, :v2)
...>   |> KeyValueSet.put!(:k3, :v3)
iex> get_in(set, [:k1])
:v1
iex> get_in(set, [:z])
nil
iex> with {:v2, set} <-
...>   pop_in(set, [:k2]), do: KeyValueSet.to_list!(set)
[k3: :v3, k1: :v1]
iex> with {nil, set} <- pop_in(set, [:z]), do: KeyValueSet.to_list!(set)
[k3: :v3, k1: :v1]
iex> with {:v1, set} <-
...>     get_and_update_in(set, [:k1], &{&1, :v42}),
...>   do: KeyValueSet.to_list!(set)
[k3: :v3, k1: :v42]
iex> with {:v42, set} <-
...>     get_and_update_in(set, [:k1], fn _ -> :pop end),
...>   do: KeyValueSet.to_list!(set)
[k3: :v3]

Link to this section Summary

Types

set_options()

t()

Functions

delete(key_value_set)

Deletes KeyValueSet. See ETS.Set.delete/1.

delete(key_value_set, key)

Deletes record with specified key in specified Set.

delete!(key_value_set)

Same as delete/1 but unwraps or raises on error.

delete!(set, key)

Same as delete/2 but unwraps or raises on error.

delete_all(key_value_set)

Deletes all records in specified Set.

delete_all!(set)

Same as delete_all/1 but unwraps or raises on error.

first(key_value_set)

Returns first key in KeyValueSet. See ETS.Set.first/1.

first!(key_value_set)

Same as first/1 but unwraps or raises on error.

get(key_value_set, key, default \\ nil)

Returns value for specified key or the provided default (nil if not specified) if no record found.

get!(key_value_set, key, default \\ nil)

Same as get/3 but unwraps or raises on error

get_table(key_value_set)

Returns underlying :ets table reference. See ETS.Set.get_table/1.

get_table!(key_value_set)

Same as get_table/1 but unwraps or raises on error.

has_key(key_value_set, key)

Determines if specified key exists in KeyValueSet. See ETS.Set.has_key/2.

has_key!(key_value_set, key)

Same as has_key/2 but unwraps or raises on error.

info(key_value_set, force_update \\ false)

Returns info on set. See ETS.Set.info/2.

info!(key_value_set, force_update \\ false)

Same as info/2 but unwraps or raises on error.

last(key_value_set)

Returns last key in KeyValueSet. See ETS.Set.last/1.

last!(key_value_set)

Same as last/1 but unwraps or raises on error.

new(opts \\ [])

Creates new Key Value Set module with the specified options.

new!(opts \\ [])

Same as new/1 but unwraps or raises on error.

next(key_value_set, key)

Returns next key in KeyValueSet. See ETS.Set.next/2.

next!(key_value_set, key)

Same as next/2 but unwraps or raises on error.

previous(key_value_set, key)

Returns previous key in KeyValueSet. See ETS.Set.previous/2.

previous!(key_value_set, key)

Same as previous/2 but unwraps or raises on error.

put(key_value_set, key, value)

Puts given value into table for given key.

put!(key_value_set, key, value)

Same as put/3 but unwraps or raises on error.

put_new(key_value_set, key, value)

Same as put/3 but doesn't put record if the key already exists.

put_new!(key_value_set, key, value)

Same as put_new/3 but unwraps or raises on error.

to_list(key_value_set)

Returns contents of table as a list. See ETS.Set.to_list/1.

to_list!(key_value_set)

Same as to_list/1 but unwraps or raises on error.

wrap_existing(table_identifier)

Wraps an existing :ets :set or :ordered_set in a KeyValueSet struct.

wrap_existing!(table_identifier)

Same as wrap_existing/1 but unwraps or raises on error.

Link to this section Types

set_options()

set_options() :: [ETS.Base.option() | {:ordered, boolean()}]

t()

t() :: %ETS.KeyValueSet{set: ETS.Set.t()}

Link to this section Functions

delete(key_value_set)

delete(ETS.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

Deletes KeyValueSet. See ETS.Set.delete/1.

delete(key_value_set, key)

delete(ETS.KeyValueSet.t(), any()) ::
  {:ok, ETS.KeyValueSet.t()} | {:error, any()}

Deletes record with specified key in specified Set.

Examples

iex> set = KeyValueSet.new!()
iex> KeyValueSet.put(set, :a, :b)
iex> KeyValueSet.delete(set, :a)
iex> KeyValueSet.get!(set, :a)
nil

delete!(key_value_set)

delete!(ETS.KeyValueSet.t()) :: any()

Same as delete/1 but unwraps or raises on error.

delete!(set, key)

delete!(ETS.KeyValueSet.t(), any()) :: ETS.KeyValueSet.t()

Same as delete/2 but unwraps or raises on error.

delete_all(key_value_set)

delete_all(ETS.KeyValueSet.t()) :: {:ok, ETS.KeyValueSet.t()} | {:error, any()}

Deletes all records in specified Set.

Examples

iex> set = KeyValueSet.new!()
iex> set
iex> |> KeyValueSet.put!(:a, :d)
iex> |> KeyValueSet.put!(:b, :d)
iex> |> KeyValueSet.put!(:c, :d)
iex> |> KeyValueSet.to_list!()
[c: :d, b: :d, a: :d]
iex> KeyValueSet.delete_all(set)
iex> KeyValueSet.to_list!(set)
[]

delete_all!(set)

delete_all!(ETS.KeyValueSet.t()) :: ETS.KeyValueSet.t()

Same as delete_all/1 but unwraps or raises on error.

first(key_value_set)

first(ETS.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

Returns first key in KeyValueSet. See ETS.Set.first/1.

first!(key_value_set)

first!(ETS.KeyValueSet.t()) :: any()

Same as first/1 but unwraps or raises on error.

get(key_value_set, key, default \\ nil)

get(ETS.KeyValueSet.t(), any(), any()) :: {:ok, any()} | {:error, any()}

Returns value for specified key or the provided default (nil if not specified) if no record found.

Examples

iex> KeyValueSet.new!()
iex> |> KeyValueSet.put!(:a, :b)
iex> |> KeyValueSet.put!(:c, :d)
iex> |> KeyValueSet.put!(:e, :f)
iex> |> KeyValueSet.get(:c)
{:ok, :d}

get!(key_value_set, key, default \\ nil)

get!(ETS.KeyValueSet.t(), any(), any()) :: any()

Same as get/3 but unwraps or raises on error

get_table(key_value_set)

get_table(ETS.KeyValueSet.t()) ::
  {:ok, ETS.table_reference()} | {:error, any()}

Returns underlying :ets table reference. See ETS.Set.get_table/1.

get_table!(key_value_set)

get_table!(ETS.KeyValueSet.t()) :: ETS.table_reference()

Same as get_table/1 but unwraps or raises on error.

has_key(key_value_set, key)

has_key(ETS.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

Determines if specified key exists in KeyValueSet. See ETS.Set.has_key/2.

has_key!(key_value_set, key)

has_key!(ETS.KeyValueSet.t(), any()) :: any()

Same as has_key/2 but unwraps or raises on error.

info(key_value_set, force_update \\ false)

info(ETS.KeyValueSet.t(), boolean()) :: {:ok, keyword()} | {:error, any()}

Returns info on set. See ETS.Set.info/2.

info!(key_value_set, force_update \\ false)

info!(ETS.KeyValueSet.t(), boolean()) :: keyword()

Same as info/2 but unwraps or raises on error.

last(key_value_set)

last(ETS.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

Returns last key in KeyValueSet. See ETS.Set.last/1.

last!(key_value_set)

last!(ETS.KeyValueSet.t()) :: any()

Same as last/1 but unwraps or raises on error.

new(opts \\ [])

new(set_options()) :: {:error, any()} | {:ok, ETS.KeyValueSet.t()}

Creates new Key Value Set module with the specified options.

Possible Options can be found in ETS.Set with the difference that specifying a keypos will result in an error.

Examples

iex> {:ok, kvset} = KeyValueSet.new(ordered: true,read_concurrency: true, compressed: false)
iex> KeyValueSet.info!(kvset)[:read_concurrency]
true

# Named :ets tables via the name keyword
iex> {:ok, kvset} = KeyValueSet.new(name: :my_ets_table)
iex> KeyValueSet.info!(kvset)[:name]
:my_ets_table

new!(opts \\ [])

new!(set_options()) :: ETS.KeyValueSet.t()

Same as new/1 but unwraps or raises on error.

next(key_value_set, key)

next(ETS.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

Returns next key in KeyValueSet. See ETS.Set.next/2.

next!(key_value_set, key)

next!(ETS.KeyValueSet.t(), any()) :: any()

Same as next/2 but unwraps or raises on error.

previous(key_value_set, key)

previous(ETS.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

Returns previous key in KeyValueSet. See ETS.Set.previous/2.

previous!(key_value_set, key)

previous!(ETS.KeyValueSet.t(), any()) :: any()

Same as previous/2 but unwraps or raises on error.

put(key_value_set, key, value)

Puts given value into table for given key.

Examples

iex> kvset = KeyValueSet.new!(ordered: true)
iex> {:ok, kvset} = KeyValueSet.put(kvset, :a, :b)
iex> KeyValueSet.get!(kvset, :a)
:b

put!(key_value_set, key, value)

put!(ETS.KeyValueSet.t(), any(), any()) :: ETS.KeyValueSet.t()

Same as put/3 but unwraps or raises on error.

put_new(key_value_set, key, value)

put_new(ETS.KeyValueSet.t(), any(), any()) ::
  {:ok, ETS.KeyValueSet.t()} | {:error, any()}

Same as put/3 but doesn't put record if the key already exists.

Examples

iex> set = KeyValueSet.new!(ordered: true)
iex> {:ok, _} = KeyValueSet.put_new(set, :a, :b)
iex> {:ok, _} = KeyValueSet.put_new(set, :a, :c) # skips due toduplicate :a key
iex> KeyValueSet.to_list!(set)
[{:a, :b}]

put_new!(key_value_set, key, value)

put_new!(ETS.KeyValueSet.t(), any(), any()) :: ETS.KeyValueSet.t()

Same as put_new/3 but unwraps or raises on error.

to_list(key_value_set)

to_list(ETS.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

Returns contents of table as a list. See ETS.Set.to_list/1.

to_list!(key_value_set)

to_list!(ETS.KeyValueSet.t()) :: any()

Same as to_list/1 but unwraps or raises on error.

wrap_existing(table_identifier)

wrap_existing(ETS.table_identifier()) ::
  {:ok, ETS.KeyValueSet.t()} | {:error, any()}

Wraps an existing :ets :set or :ordered_set in a KeyValueSet struct.

Examples

iex> :ets.new(:my_ets_table, [:set, :named_table])
iex> {:ok, set} = KeyValueSet.wrap_existing(:my_ets_table)
iex> KeyValueSet.info!(set)[:name]
:my_ets_table

wrap_existing!(table_identifier)

wrap_existing!(ETS.table_identifier()) :: ETS.KeyValueSet.t()

Same as wrap_existing/1 but unwraps or raises on error.