drewkit / elm-bit-flags / BitFlags

A package for handling Int values as bit flag registers.


type BitFlagSettings

BitFlagSettings type

Initializing / Configuring Bit Flag Settings

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

Initialize bit flag settings

defaultSettings : Basics.Int -> BitFlagSettings

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.

deleteFlag : String -> BitFlagSettings -> BitFlagSettings

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 Bit Flag operations on registers

enableFlag : BitFlagSettings -> String -> Basics.Int -> Basics.Int

Enable a flag on a register.

disableFlag : BitFlagSettings -> String -> Basics.Int -> Basics.Int

Disable a flag on a register.

flipFlag : BitFlagSettings -> String -> Basics.Int -> Basics.Int

Flip flag value on a register.

Investigate registers

enabledFlags : BitFlagSettings -> Basics.Int -> List String

List all enabled flags on a register.

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

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