https://github.com/igas/custom_base

Allow you to make custom base conversion in Elixir.
https://github.com/igas/custom_base

decoder decoding elixir encoder encoding hacktoberfest

Last synced: about 1 month ago
JSON representation

Allow you to make custom base conversion in Elixir.

• Host: GitHub
• URL: https://github.com/igas/custom_base
• Owner: igas
• License: mit
• Created: 2015-03-07T04:30:40.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-09-26T15:26:44.000Z (3 months ago)
• Last Synced: 2024-11-06T06:03:11.374Z (about 1 month ago)
• Topics: decoder, decoding, elixir, encoder, encoding, hacktoberfest
• Language: Elixir
• Homepage:
• Size: 48.8 KB
• Stars: 22
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Allow you to make custom base conversion in Elixir. (Text and Numbers)
• fucking-awesome-elixir - custom_base - Allow you to make custom base conversion in Elixir. (Text and Numbers)
• awesome-elixir - custom_base - Allow you to make custom base conversion in Elixir. (Text and Numbers)

README

        
# CustomBase

[![Test](https://github.com/igas/custom_base/workflows/Test/badge.svg)](https://github.com/igas/custom_base/actions?query=workflow%3ATest)

[![Module Version](https://img.shields.io/hexpm/v/custom_base.svg)](https://hex.pm/packages/custom_base)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/custom_base/)

[![Total Download](https://img.shields.io/hexpm/dt/custom_base.svg)](https://hex.pm/packages/custom_base)

[![License](https://img.shields.io/hexpm/l/custom_base.svg)](https://github.com/igas/custom_base/blob/main/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/igas/custom_base.svg)](https://github.com/igas/custom_base/commits/main)

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:

```elixir

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](https://github.com/igas/custom_base/blob/main/LICENSE)

for details.