igas / custom_base

Allow you to make custom base conversion in Elixir.

CustomBase

CustomBase allow you to make custom base conversion in Elixir.

Installation

Add {:custom_base, "~> 0.2"} to deps function in your mix.exs file.

After you are done, run mix deps.get in your shell to fetch and compile CustomBase.

Examples

Lets make Base12 module with conversion described below.

Value	Encoding
0	0
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
10	A
11	B

Add macro to your module:

defmodule Base12 do
  use CustomBase, '0123456789AB'
end

Now your module have 2 functions encode/1 and decode/1:

iex> Base12.encode(9)
"9"
iex> Base12.encode(10)
"A"
iex> Base12.encode(11)
"B"
iex> Base12.encode(12)
"10"
iex> Base12.decode("16")
18
iex> Base12.decode("AB")
131

Specs & Docs

All specs included by this library, if you want to provide your documentation, add it after use call, like this:

defmodule Base12 do
  use CustomBase, '0123456789AB'

  @moduledoc """
  Your module docs.
  """

  @doc """
  Documentation for encode/1.
  """
  def encode(integer)

  @doc """
  Documentation for decode/1.
  """
  def decode(binary)

  @doc """
  Documentation for decode!/1.
  """
  def decode!(binary)
end

License

Copyright (c) 2015 Igor Kapkov

This library is MIT licensed. See the LICENSE for details.

custom_base's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update erlef/setup-beam action to v1.18.1

Detected dependencies

github-actions

.github/workflows/test.yml

• actions/checkout v4.1.7@692973e3d937129bcbf40652eb9f2f61becf3332
• erlef/setup-beam v1.17.6@0a541161e47ec43ccbd9510053c5f336ca76c2a2

mix

mix.exs

• ex_doc >= 0.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Dependabot can't evaluate your Elixir dependency files

Dependabot can't evaluate your Elixir dependency files.

As a result, Dependabot couldn't check whether any of your dependencies are out-of-date.

The error Dependabot encountered was:

Unchecked dependencies for environment dev:
* jason (Hex package)
  the dependency is not available, run "mix deps.get"
** (Mix) Can't continue due to errors on dependencies

You can mention @dependabot in the comments below to contact the Dependabot team.