Gel.NamedTuple (Gel v0.9.0)

An immutable value representing an Gel named tuple value.

Gel.NamedTuple implements Access behavior to access fields by index or key and Enumerable protocol for iterating over tuple values.

iex(1)> {:ok, client} = Gel.start_link()
iex(2)> nt = Gel.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
#Gel.NamedTuple<a: 1, b: "a", c: [3]>
iex(3)> nt[:b]
"a"
iex(4)> nt["c"]
[3]
iex(4)> nt[0]
1

Summary

Types

t()

An immutable value representing an Gel named tuple value.

Functions

keys(named_tuple)

Get named tuple keys.

to_map(named_tuple)

Convert a named tuple into a regular map.

to_tuple(nt)

Convert a named tuple to a regular erlang tuple.

Types

t()

@opaque t()

An immutable value representing an Gel named tuple value.

Functions

keys(named_tuple)

@spec keys(t()) :: [String.t()]

Get named tuple keys.

iex(1)> {:ok, client} = Gel.start_link()
iex(2)> nt = Gel.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> Gel.NamedTuple.keys(nt)
["a", "b", "c"]

to_map(named_tuple)

(since 0.3.0)

@spec to_map(t()) :: %{required(String.t()) => term()}

Convert a named tuple into a regular map.

iex(1)> {:ok, client} = Gel.start_link()
iex(2)> nt = Gel.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> Gel.NamedTuple.to_map(nt)
%{"a" => 1, "b" => "a", "c" => [3]}

to_tuple(nt)

@spec to_tuple(t()) :: tuple()

Convert a named tuple to a regular erlang tuple.

iex(1)> {:ok, client} = Gel.start_link()
iex(2)> nt = Gel.query_required_single!(client, "select (a := 1, b := 'a', c := [3])")
iex(3)> Gel.NamedTuple.to_tuple(nt)
{1, "a", [3]}