Waits to accept ownership of a table after it is given away. Successful receipt will return {:ok, %{kv_set: kv_set, from: from, gift: gift}} where from is the pid of the previous owner, and gift is any additional metadata sent with the table.

A timeout may be given in milliseconds, which will return {:error, :timeout} if reached.

See give_away/3 for more information.

For processes which may receive ownership of a KeyValueSet unexpectedly - either via give_away/3 or by being named the KeyValueSet's heir (see new/1) - the module should include at least one accept clause. For example, if we want a server to inherit KeyValueSets after their previous owner dies:

defmodule Receiver do
  use GenServer
  alias ETS.KeyValueSet
  require ETS.KeyValueSet

  ...

  KeyValueSet.accept :owner_crashed, kv_set, _from, state do
    new_state = Map.update!(state, :crashed_sets, &[kv_set | &1])
    {:noreply, new_state}
  end

The first argument is a unique identifier which should match either the "heir_data" in new/1, or the "gift" in give_away/3. The other arguments declare the variables which may be used in the do block: the received KeyValueSet, the pid of the previous owner, and the current state of the process.

The return value should be in the form {:noreply, new_state}, or one of the similar returns expected by handle_info/handle_cast.

Specs

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

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

Specs

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

Deletes record with specified key in specified Set.

examples

Examples

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

Specs

delete!(t()) :: any()

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

Specs

delete!(t(), any()) :: t()

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

Specs

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

Deletes all records in specified Set.

examples

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)
[]

Specs

delete_all!(t()) :: t()

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

Specs

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

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

Specs

first!(t()) :: any()

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

Specs

get(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

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}

Specs

get!(t(), any(), any()) :: any()

Same as get/3 but unwraps or raises on error

Specs

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

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

Specs

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

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

Specs

give_away(t(), pid(), any()) :: {:ok, t()} | {:error, any()}

Transfers ownership of a KeyValueSet to another process.

examples

Examples

iex> kv_set = KeyValueSet.new!()
iex> receiver_pid = spawn(fn -> KeyValueSet.accept() end)
iex> KeyValueSet.give_away(kv_set, receiver_pid)
{:ok, kv_set}

iex> kv_set = KeyValueSet.new!()
iex> dead_pid = ETS.TestUtils.dead_pid()
iex> KeyValueSet.give_away(kv_set, dead_pid)
{:error, :recipient_not_alive}

Specs

give_away!(t(), pid(), any()) :: t()

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

Specs

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

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

Specs

has_key!(t(), any()) :: any()

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

Specs

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

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

Specs

info!(t(), boolean()) :: keyword()

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

Specs

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

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

Specs

last!(t()) :: any()

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

Specs

new(set_options()) :: {:error, any()} | {:ok, 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

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

Specs

new!(set_options()) :: t()

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

Specs

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

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

Specs

next!(t(), any()) :: any()

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

Specs

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

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

Specs

previous!(t(), any()) :: any()

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

Puts given value into table for given key.

examples

Examples

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

Specs

put!(t(), any(), any()) :: t()

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

Specs

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

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

examples

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}]

Specs

put_new!(t(), any(), any()) :: t()

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

Specs

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

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

Specs

to_list!(t()) :: any()

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

Specs

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

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

examples

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

Specs

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

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