NimbleOptions v0.5.2

View Source NimbleOptions.ValidationError exception (NimbleOptions v0.5.2)

An error that is returned (or raised) when options are invalid.

Only the following documented fields are considered public. All other fields are considered private and should not be referenced:

  • :key - The key that did not successfully validate.

  • :keys_path - If the key is nested, this is the path to the key.

  • :value - The value that failed to validate. This field is nil if there was no value provided.

Since this is an exception, you can either raise it directly with raise/1 or turn it into a message string with Exception.message/1.

Link to this section Summary

Types

t()

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %NimbleOptions.ValidationError{
  __exception__: true,
  key: term(),
  keys_path: term(),
  message: term(),
  value: term()
}