ets v0.7.1 Ets.Set.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

Functions

Same as delete/1 but unwraps or raises on error

Same as delete/2 but unwraps or raises on error

Deletes KeyValueSet. See Ets.Set.delete/1

Deletes record with specified key in specified Set

Same as delete_all/1 but unwraps or raises on error

Deletes all records in specified Set

Same as first/1 but unwraps or raises on error

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

Same as get/3 but unwraps or raises on error

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

Same as get_table/1 but unwraps or raises on error

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

Same as has_key/2 but unwraps or raises on error

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

Same as info/2 but unwraps or raises on error

Same as last/1 but unwraps or raises on error

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

Same as new/1 but unwraps or raises on error

Creates new Key Value Set module with the specified options

Same as next/2 but unwraps or raises on error

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

Same as previous/2 but unwraps or raises on error

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

Same as put/3 but unwraps or raises on error

Puts given value into table for given key

Same as put_new/3 but unwraps or raises on error

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

Same as to_list/1 but unwraps or raises on error

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

Same as wrap_existing/1 but unwraps or raises on error

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

Link to this section Types

Link to this type set_options() View Source
set_options() :: [Ets.Base.option() | {:ordered, boolean()}]
Link to this type t() View Source
t() :: %Ets.Set.KeyValueSet{set: Ets.Set.t()}

Link to this section Functions

Link to this function delete!(key_value_set) View Source
delete!(Ets.Set.KeyValueSet.t()) :: any()

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

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

Link to this function delete(key_value_set) View Source
delete(Ets.Set.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

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

Link to this function delete(key_value_set, key) View Source
delete(Ets.Set.KeyValueSet.t(), any()) ::
  {:ok, Ets.Set.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

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

Link to this function delete_all(key_value_set) View Source
delete_all(Ets.Set.KeyValueSet.t()) ::
  {:ok, Ets.Set.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)
[]

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

Link to this function first(key_value_set) View Source
first(Ets.Set.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

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

Link to this function get!(key_value_set, key, default \\ nil) View Source
get!(Ets.Set.KeyValueSet.t(), any(), any()) :: any()

Same as get/3 but unwraps or raises on error

Link to this function get(key_value_set, key, default \\ nil) View Source
get(Ets.Set.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}

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

Link to this function get_table(key_value_set) View Source
get_table(Ets.Set.KeyValueSet.t()) ::
  {:ok, Ets.table_reference()} | {:error, any()}

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

Link to this function has_key!(key_value_set, key) View Source
has_key!(Ets.Set.KeyValueSet.t(), any()) :: any()

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

Link to this function has_key(key_value_set, key) View Source
has_key(Ets.Set.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

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

Link to this function info!(key_value_set, force_update \\ false) View Source

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

Link to this function info(key_value_set, force_update \\ false) View Source
info(Ets.Set.KeyValueSet.t(), boolean()) :: {:ok, keyword()} | {:error, any()}

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

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

Link to this function last(key_value_set) View Source
last(Ets.Set.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

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

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

Link to this function new(opts \\ []) View Source
new(set_options()) :: {:error, any()} | {:ok, Ets.Set.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
Link to this function next!(key_value_set, key) View Source
next!(Ets.Set.KeyValueSet.t(), any()) :: any()

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

Link to this function next(key_value_set, key) View Source
next(Ets.Set.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

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

Link to this function previous!(key_value_set, key) View Source
previous!(Ets.Set.KeyValueSet.t(), any()) :: any()

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

Link to this function previous(key_value_set, key) View Source
previous(Ets.Set.KeyValueSet.t(), any()) :: {:ok, any()} | {:error, any()}

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

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

Link to this function put(key_value_set, key, value) View Source

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
Link to this function put_new!(key_value_set, key, value) View Source

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

Link to this function put_new(key_value_set, key, value) View Source
put_new(Ets.Set.KeyValueSet.t(), any(), any()) ::
  {:ok, Ets.Set.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}]
Link to this function to_list!(key_value_set) View Source
to_list!(Ets.Set.KeyValueSet.t()) :: any()

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

Link to this function to_list(key_value_set) View Source
to_list(Ets.Set.KeyValueSet.t()) :: {:ok, any()} | {:error, any()}

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

Link to this function wrap_existing!(table_identifier) View Source

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

Link to this function wrap_existing(table_identifier) View Source
wrap_existing(Ets.table_identifier()) ::
  {:ok, Ets.Set.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