drewkit/elm-bit-flags/2.1.0

BitFlags

A package for handling Int values as bit flag registers.

BitFlagSettings type

Initializing / Configuring Bit Flag Settings

{ bitLimit : Int
, flags : List String
}
-> Result String BitFlagSettings

Initialize bit flag settings

Default bit flag settings

createFlag : String -> BitFlagSettings -> Result String BitFlagSettings

Create a flag from the bit flag settings

updateFlag : String -> String -> BitFlagSettings -> BitFlagSettings

Update a flag on the bit flag settings.

Delete a flag from the bit flag settings.

allFlags : BitFlagSettings -> List String

List all created flags on bit flag settings

serialize : BitFlagSettings -> List String

Serialize bit flag settings.

Performing Bitwise operations on registers

enableFlag : BitFlagSettings -> String -> Int -> Int

Enable a flag on a register.

disableFlag : BitFlagSettings -> String -> Int -> Int

Disable a flag on a register.

flipFlag : BitFlagSettings -> String -> Int -> Int

Flip flag value on a register.

Investigate registers

enabledFlags : BitFlagSettings -> Int -> List String

List all enabled flags on a register.

match : BitFlagSettings -> List String -> List String -> Int -> Bool

With a whitelist and blacklist of flags, determine if the register is a match

genRegister : BitFlagSettings -> Set String -> Int

Generate a register based on a set of flags

genSet : BitFlagSettings -> Int -> Set String

Generate a flag set based on register