Conferer.Key.Internal

Internal module for Key related features

Documentation

newtype Key

This type is used extensivelly as a way to point into a Source and in turn into a Config. The intended way to create them is is using mkKey.

It's a list of alphanumeric words and each Source can interpret it as it sees fit.

Constructors

Key

Fields

• unKey :: [Text]

Instances

Eq Key

Defined in Conferer.Key.Internal

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Defined in Conferer.Key.Internal

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in Conferer.Key.Internal

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

IsString Key

Defined in Conferer.Key.Internal

Methods

fromString :: String -> Key

mkKey :: String -> Key

Helper function to create Keys, this function always works, but since Keys reject some string this function transforms the input to provide lawful Keys instead of throwing.

For example:

'mkKey' "sOmE.KEy" == "some.key"
'mkKey' "1.key" == "1.key"
'mkKey' "1_thing.key" == "1thing.key"
'mkKey' "some....key" == "some.key"
'mkKey' ".." == ""

fromText :: Text -> Key

Same as mkKey but for Text

keyName :: Key -> Text

Collapse a key into a textual representation

isKeyPrefixOf :: Key -> Key -> Bool

This function tells if a key is a subkey of another key based using key fragments instead of letters as units

'isKeyPrefixOf' "foo" "foo.bar" == True
'isKeyPrefixOf' "foo" "foo" == True
'isKeyPrefixOf' "foo" "fooa" == False

stripKeyPrefix :: Key -> Key -> Maybe Key

Given k1 and k2 this function drops k1 as a prefix from k2, if k1 is not a prefix of k2 it returns Nothing

'keyPrefixOf' "foo" "foo.bar" == Just "bar"
'keyPrefixOf' "foo" "foo" == Just ""
'keyPrefixOf' "foo" "fooa" == Nothing
'keyPrefixOf' "" k == Just k

(/.) :: Key -> Key -> Key

Concatenate two keys

rawKeyComponents :: Key -> [Text]

Get raw components from a key, usually to do some manipulation

unconsKey :: Key -> Maybe (Text, Key)

Get first component of a key and the rest of the key

isValidKeyFragment :: Text -> Bool

Check if a Text is a valid fragment of a Key, meaning that each character isKeyCharacter

isKeyCharacter :: Char -> Bool

Checks if the given Char is a valid for a Key. Meaning it is a lower case ascii letter or a number.