View Source Bitmask

Hex.pm Hex Docs

A bitmask implementation for elixir, with optional Ecto support.

usage

Usage

define-your-bitmask

Define your bitmask

defmodule MyBitmask do
  use Bitmask, [
    :flag_1,
    :flag_2,
    :flag_3,
    :flag_4,
  ]
end

create-your-bitmask

Create your bitmask

iex> bitmask = MyBitmask.atom_flags_to_bitmask([:flag_1, :flag_3])
%MyBitmask{bitmask: 5, flags: [:flag_1, :flag_3]}

check-if-we-have-a-flag

Check if we have a flag

iex> MyBitmask.has_flag(bitmask, :flag_1])
true

store-it-in-an-ecto-schema

Store it in an Ecto schema

defmodule SomeEctoSchema do
  use Ecto.Schema
  schema "bitmasks" do
    field :my_bitmask, MyBitmask
  end
end

See the docs for more info. Issues / PRs / Feedback welcome.