View Source ExToolkit.Kernel (ExToolkit v0.9.13)

Basic language primitives to ease development flow.

Summary

Types

type()

Functions

defattr(attrs)

Defines a module attribute and a function to get it. Inspired by attr_reader from ruby.

error()

Returns the atom :error.

error(value)

Wraps a given value in a tuple tagged with :error.

noreply(value)

Wraps a given value in a tuple tagged with :noreply.

ok()

Returns the atom :ok.

ok(value)

Wraps a given value in a tuple tagged with :ok.

type_of(a)

Determines the type of the given term.

validate_opts!(opts, defaults)

Validates the given options against the given defaults.

Types

type()

@type type() ::
  nil
  | :float
  | :integer
  | :boolean
  | :atom
  | :binary
  | :list
  | :tuple
  | :exception
  | :struct
  | :map
  | :function
  | :pid
  | :term

Functions

defattr(attrs)

(macro)

Defines a module attribute and a function to get it. Inspired by attr_reader from ruby.

Examples 

iex> defmodule ExampleModule do
...>   require ExToolkit.Kernel
...>   defattr foo: :bar
...> end
iex> ExampleModule.foo()
:bar

iex> defmodule ExampleModule2 do
...>   require ExToolkit.Kernel
...>   defattr name: "ExToolkit", version: "1.0.0"
...> end
iex> %{name: ExampleModule2.name(), version: ExampleModule2.version()}
%{name: "ExToolkit", version: "1.0.0"}

iex> defmodule ExampleModule3 do
...>   require ExToolkit.Kernel
...>   defattr [version: Version.parse!("1.0.1")]
...> end
iex> ExampleModule3.version()
%Version{major: 1, minor: 0, patch: 1}

error()

@spec error() :: :error

Returns the atom :error.

Example 

iex> error()
:error

error(value)

@spec error(term()) :: {:error, term()}

Wraps a given value in a tuple tagged with :error.

Examples 

iex> error("something went wrong")
{:error, "something went wrong"}

iex> error(404)
{:error, 404}

noreply(value)

@spec noreply(term()) :: {:noreply, term()}

Wraps a given value in a tuple tagged with :noreply.

Examples 

iex> noreply("something went wrong")
{:noreply, "something went wrong"}

iex> noreply(404)
{:noreply, 404}

ok()

@spec ok() :: :ok

Returns the atom :ok.

Example 

iex> ok()
:ok

ok(value)

@spec ok(term()) :: {:ok, term()}

Wraps a given value in a tuple tagged with :ok.

Examples 

iex> ok(42)
{:ok, 42}

iex> ok("hello")
{:ok, "hello"}

type_of(a)

@spec type_of(term()) :: type()

Determines the type of the given term.

Examples 

iex> type_of(3.14)
:float

iex> type_of(42)
:integer

iex> type_of(true)
:boolean

iex> type_of(:atom)
:atom

iex> type_of("string")
:binary

iex> type_of([1, 2, 3])
:list

iex> type_of({:ok, 1})
:tuple

iex> type_of(%{})
:map

iex> type_of(fn -> :ok end)
:function

iex> type_of(%URI{})
:struct

iex> type_of(%RuntimeError{})
:exception

iex> type_of(self())
:pid

iex> type_of(nil)
nil

validate_opts!(opts, defaults)

@spec validate_opts!(keyword() | map(), keyword() | map()) :: map()

Validates the given options against the given defaults.

Examples 

iex> validate_opts!([foo: :bar], [foo: :baz])
%{foo: :bar}

iex> validate_opts!([], [foo: :baz])
%{foo: :baz}

iex> validate_opts!([foo: :bar, bar: :baz], %{foo: :bar})
** (ArgumentError) unknown keys [:bar] in [foo: :bar, bar: :baz], the allowed keys are: [:foo]

iex> validate_opts!(%{foo: :bar, bar: :baz}, %{foo: :bar, bar: :baz})
%{foo: :bar, bar: :baz}

iex> validate_opts!(%{foo: :bar}, [foo: :bar])
%{foo: :bar}

iex> validate_opts!(%{foo: :bar}, [foo: :baz, bar: :zad])
%{foo: :bar, bar: :zad}