bricks

# Copyright (c) 2018 James Laver
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

defmodule Bricks.Error.BadCombo do
  @moduledoc """
  A bad combination of options was provided
  """
  @enforce_keys [:vals, :message]
  defstruct @enforce_keys

  alias Bricks.Error.BadCombo

  @typedoc "Key of the option"
  @type vals :: map()

  @typedoc "A message describing the problem"
  @type message :: binary()

  @typedoc "A bad combination of options was provided"
  @type t :: %BadCombo{
          vals: vals(),
          message: binary()
        }

  @spec new(vals(), message()) :: t()
  @doc "Creates a new `Bricks.Error.BadCombo` with the given `vals` and `message`"
  def new(vals, message) do
    %BadCombo{vals: vals, message: message}
  end
end