Guardsafe v0.2.0 → Overview → Guardsafe

Guardsafe

Summary
Macros

Provides readability-enhancing macros that can safely be used in guard clauses.

Source

Summary↑

atom?(term)	Expands `atom?(term)` into `is_atom(term)`
binary?(term)	Expands `binary?(term)` into `is_binary(term)`
bitstring?(term)	Expands `bitstring?(term)` into `is_bitstring(term)`
boolean?(term)	Expands `boolean?(term)` into `is_boolean(term)`
divisible_by?(number, divisor)	Expands `divisible_by?(number, divisor)` into `rem(number, divisor) == 0`
float?(term)	Expands `float?(term)` into `is_float(term)`
function?(term)	Expands `function?(term)` into `is_function(term)`
function?(term, arity)	Expands `function?(term, arity)` into `is_function(term, arity)`
integer?(term)	Expands `integer?(term)` into `is_integer(term)`
list?(term)	Expands `list?(term)` into `is_list(term)`
map?(term)	Expands `map?(term)` into `is_map(term)`
nil?(term)	Expands `nil?(term)` into `is_nil(term)`
number?(term)	Expands `number?(term)` into `is_number(term)`
pid?(term)	Expands `pid?(term)` into `is_pid(term)`
port?(term)	Expands `port?(term)` into `is_port(term)`
reference?(term)	Expands `reference?(term)` into `is_reference(term)`
tuple?(term)	Expands `tuple?(term)` into `is_tuple(term)`

Macros

atom?(term)

(macro) # ↑

Expands atom?(term) into is_atom(term)

Examples

iex> some_atom_variable |> atom?
true

Source

binary?(term)

(macro) # ↑

Expands binary?(term) into is_binary(term)

Examples

iex> some_binary_variable |> binary?
true

Source

bitstring?(term)

(macro) # ↑

Expands bitstring?(term) into is_bitstring(term)

Examples

iex> some_bitstring_variable |> bitstring?
true

Source

boolean?(term)

(macro) # ↑

Expands boolean?(term) into is_boolean(term)

Examples

iex> some_boolean_variable |> boolean?
true

Source

divisible_by?(number, divisor)

(macro) # ↑

Expands divisible_by?(number, divisor) into rem(number, divisor) == 0

Examples

iex> 25 |> divisible_by? 5
true

Source

float?(term)

(macro) # ↑

Expands float?(term) into is_float(term)

Examples

iex> some_float_variable |> float?
true

Source

function?(term)

(macro) # ↑

Expands function?(term) into is_function(term)

Examples

iex> some_function_variable |> function?
true

Source

function?(term, arity)

(macro) # ↑

Expands function?(term, arity) into is_function(term, arity)

Examples

iex> &String.to_integer/1 |> function?(2)
false

Source

integer?(term)

(macro) # ↑

Expands integer?(term) into is_integer(term)

Examples

iex> some_integer_variable |> integer?
true

Source

list?(term)

(macro) # ↑

Expands list?(term) into is_list(term)

Examples

iex> some_list_variable |> list?
true

Source

map?(term)

(macro) # ↑

Expands map?(term) into is_map(term)

Examples

iex> some_map_variable |> map?
true

Source

nil?(term)

(macro) # ↑

Expands nil?(term) into is_nil(term)

Examples

iex> some_nil_variable |> nil?
true

Source

number?(term)

(macro) # ↑

Expands number?(term) into is_number(term)

Examples

iex> some_number_variable |> number?
true

Source

pid?(term)

(macro) # ↑

Expands pid?(term) into is_pid(term)

Examples

iex> some_pid_variable |> pid?
true

Source

port?(term)

(macro) # ↑

Expands port?(term) into is_port(term)

Examples

iex> some_port_variable |> port?
true

Source

reference?(term)

(macro) # ↑

Expands reference?(term) into is_reference(term)

Examples

iex> some_reference_variable |> reference?
true

Source

tuple?(term)

(macro) # ↑

Expands tuple?(term) into is_tuple(term)

Examples

iex> some_tuple_variable |> tuple?
true

Source