Packages

crux_structs

0.2.3
0.2.3 0.2.2 0.2.1 0.2.0 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Library providing Discord API structs for crux.

HexDocs

Current section

Files

Jump to
Readme
11 Versions
0 Dependencies
Dependants
Files
Activity
crux_structs lib structs user flags.ex
Raw

lib/structs/user/flags.ex 

defmodule Crux.Structs.User.Flags do

  @moduledoc """

  Custom non discord API struct helping with the usage of user flags.



  Discord is only providing a not documented subset of the available flags to bots.

  """



  alias Crux.Structs.Util

  use Bitwise



  flags = %{

    discord_employee: 1 <<< 0,

    discord_partner: 1 <<< 1,

    hypesquad_events: 1 <<< 2,

    bughunter_level_1: 1 <<< 3,

    # 4

    # 5

    house_bravery: 1 <<< 6,

    house_brilliance: 1 <<< 7,

    house_balance: 1 <<< 8,

    early_supporter: 1 <<< 9,

    team_user: 1 <<< 10,

    # 11

    system: 1 <<< 12,

    # 13

    bughunter_level_2: 1 <<< 14,

    # 15

    verified_bot: 1 <<< 16,

    verified_developer: 1 <<< 17

  }



  use Crux.Structs.BitField, flags



  require Util



  Util.modulesince("0.2.3")



  @typedoc """

  Union type of all valid user flags.

  """

  Util.typesince("0.2.3")



  @type name ::

          :discord_employee

          | :discord_partner

          | :hypesquad_events

          | :bughunter_level_1

          | :house_bravery

          | :house_brilliance

          | :house_balance

          | :early_supporter

          | :team_user

          | :system

          | :bughunter_level_2

          | :verified_bot

          | :verified_developer

end