View Source SensitiveData.Guards (Sensitive Data v0.1.0)

Guards for sensitive data wrappers.

This module includes guards that work with SensitiveData.Wrapper.t/0 wrappers. For example:

import SensitiveData.Guards, only: [is_sensitive_binary: 1]

def send_request(api_key) when is_sensitive_binary(api_key) do
  ...
end

For more information on guards, refer to Elixir's Patterns and guards page.

Summary

Functions

is_sensitive(term)

Returns true if term is a SensitiveData.Wrapper.t/0; otherwise returns false.

is_sensitive(term, struct_name)

Returns true if term is a SensitiveData.Wrapper.t/0 and struct_name is the wrapper implementation module; otherwise returns false.

is_sensitive_atom(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an atom; otherwise returns false.

is_sensitive_binary(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a binary; otherwise returns false.

is_sensitive_bitstring(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a bitstring; otherwise returns false.

is_sensitive_boolean(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a boolean; otherwise returns false.

is_sensitive_exception(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an exception; otherwise returns false.

is_sensitive_exception(term, name)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an exception of name; otherwise returns false.

is_sensitive_float(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a float; otherwise returns false.

is_sensitive_function(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a function; otherwise returns false.

is_sensitive_function(term, arity)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a function that can be applied with arity number of arguments; otherwise returns false.

is_sensitive_integer(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an integer; otherwise returns false.

is_sensitive_list(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a list; otherwise returns false.

is_sensitive_map(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a map; otherwise returns false.

is_sensitive_nil(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing nil; otherwise returns false.

is_sensitive_number(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an integer or a float; otherwise returns false.

is_sensitive_tuple(term)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a tuple; otherwise returns false.

Functions

is_sensitive(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0; otherwise returns false.

Allowed in guard tests.

is_sensitive(term, struct_name)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 and struct_name is the wrapper implementation module; otherwise returns false.

Allowed in guard tests.

is_sensitive_atom(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an atom; otherwise returns false.

Allowed in guard tests.

is_sensitive_binary(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a binary; otherwise returns false.

Allowed in guard tests.

is_sensitive_bitstring(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a bitstring; otherwise returns false.

Allowed in guard tests.

is_sensitive_boolean(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a boolean; otherwise returns false.

Allowed in guard tests.

is_sensitive_exception(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an exception; otherwise returns false.

Allowed in guard tests.

is_sensitive_exception(term, name)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an exception of name; otherwise returns false.

Allowed in guard tests.

is_sensitive_float(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a float; otherwise returns false.

Allowed in guard tests.

is_sensitive_function(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a function; otherwise returns false.

Allowed in guard tests.

is_sensitive_function(term, arity)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a function that can be applied with arity number of arguments; otherwise returns false.

Allowed in guard tests.

is_sensitive_integer(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an integer; otherwise returns false.

Allowed in guard tests.

is_sensitive_list(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a list; otherwise returns false.

Allowed in guard tests.

is_sensitive_map(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a map; otherwise returns false.

Allowed in guard tests.

is_sensitive_nil(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing nil; otherwise returns false.

Allowed in guard tests.

is_sensitive_number(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing an integer or a float; otherwise returns false.

Allowed in guard tests.

is_sensitive_tuple(term)

(macro)

Returns true if term is a SensitiveData.Wrapper.t/0 containing a tuple; otherwise returns false.

Allowed in guard tests.