Packages

islands_coord

0.1.7
0.1.42 0.1.41 0.1.40 0.1.39 0.1.38 0.1.36 0.1.35 0.1.34 0.1.33 0.1.32 0.1.31 0.1.30 0.1.29 0.1.28 0.1.27 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1

A coordinates struct and functions for the Game of Islands.

HexDocs

Current section

Files

Jump to
Readme
41 Versions
3 Dependencies
Dependants
Files
Activity
islands_coord lib islands coord.ex
Raw

lib/islands/coord.ex 

# ┌────────────────────────────────────────────────────────────────────┐

# │ Based on the book "Functional Web Development" by Lance Halvorsen. │

# └────────────────────────────────────────────────────────────────────┘

defmodule Islands.Coord do

  use PersistConfig



  @book_ref Application.get_env(@app, :book_ref)



  @moduledoc """

  Creates a `coord` struct for the _Game of Islands_.

  \n##### #{@book_ref}

  """



  alias __MODULE__



  @coord_range 1..10



  @derive [Poison.Encoder]

  @derive Jason.Encoder

  @enforce_keys [:row, :col]

  defstruct [:row, :col]



  @type col :: 1..10

  @type row :: 1..10

  @type t :: %Coord{row: row, col: col}



  @spec new(row, col) :: {:ok, t} | {:error, atom}

  def new(row, col) when row in @coord_range and col in @coord_range do

    {:ok, %Coord{row: row, col: col}}

  end



  def new(_row, _col), do: {:error, :invalid_coordinates}

end