Lamina.Cast (lamina v0.4.4)

A helpful library of casts.

Defining a cast function is brain-dead simple, however sometimes you just don't want to write the same thing over and over. Here is a helpful pile of functions for common configuration castings.

Feel free to open a PR to add more.

Summary

Functions

to_atom(value)

Attempt to convert the inbound value into an atom.

to_boolean(value)

Attempt to convert the inbound value into a boolean.

to_float(value)

Attempts to convert the inbound value into an float.

to_integer(value)

Attempts to convert the inbound value into an integer.

to_string(value)

Attempt to convert the inbound value into an atom.

Functions

to_atom(value)

@spec to_atom(integer() | float() | binary() | charlist()) :: atom() | no_return()

Attempt to convert the inbound value into an atom.

to_boolean(value)

@spec to_boolean(any()) :: boolean() | no_return()

Attempt to convert the inbound value into a boolean.

Things that are considered true:

A literal true.
The words "true" or "yes" in any capitalisation.

Everything else is false.

to_float(value)

@spec to_float(integer() | float() | binary() | charlist()) :: float() | no_return()

Attempts to convert the inbound value into an float.

to_integer(value)

@spec to_integer(integer() | float() | binary() | charlist()) ::
  integer() | no_return()

Attempts to convert the inbound value into an integer.

to_string(value)

@spec to_string(integer() | float() | binary() | charlist()) ::
  String.t() | no_return()

Attempt to convert the inbound value into an atom.