Toml.Type.Key

Implementation of key type. The type is used for key-value pairs and table names.

Since: 1.3.0.0

Core types

newtype Key

Key of value in key = val pair. Represents as non-empty list of key components — Pieces. Key like

site."google.com"

is represented like

Key (Piece "site" :| [Piece "\"google.com\""])

Since: 0.0.0

Constructors

Key

Fields

• unKey :: NonEmpty Piece

Instances

IsString Key

Split a dot-separated string into Key. Empty string turns into a Key with single element — empty Piece.

This instance is not safe for now. Use carefully. If you try to use as a key string like this site."google.com" you will have list of three components instead of desired two.

Since: 0.1.0

Defined in Toml.Type.Key

Methods

fromString :: String -> Key

Semigroup Key

Defined in Toml.Type.Key

Methods

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

sconcat :: NonEmpty Key -> Key

stimes :: Integral b => b -> Key -> Key

Generic Key

Defined in Toml.Type.Key

Associated Types

type Rep Key :: Type -> Type

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Show Key

Defined in Toml.Type.Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

NFData Key

Defined in Toml.Type.Key

Methods

rnf :: Key -> ()

Eq Key

Defined in Toml.Type.Key

Methods

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

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

Ord Key

Defined in Toml.Type.Key

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

Hashable Key

Defined in Toml.Type.Key

Methods

hashWithSalt :: Int -> Key -> Int

hash :: Key -> Int

type Rep Key

Defined in Toml.Type.Key

type Rep Key = D1 ('MetaData "Key" "Toml.Type.Key" "tomland-1.3.3.2-JRrBhNpiCh26pzVBpYNNR0" 'True) (C1 ('MetaCons "Key" 'PrefixI 'True) (S1 ('MetaSel ('Just "unKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty Piece))))

type Prefix = Key

Type synonym for Key.

Since: 0.0.0

newtype Piece

Represents the key piece of some layer.

Since: 0.0.0

Constructors

Piece

Fields

• unPiece :: Text

Instances

IsString Piece

Defined in Toml.Type.Key

Methods

fromString :: String -> Piece

Generic Piece

Defined in Toml.Type.Key

Associated Types

type Rep Piece :: Type -> Type

Methods

from :: Piece -> Rep Piece x

to :: Rep Piece x -> Piece

Show Piece

Defined in Toml.Type.Key

Methods

showsPrec :: Int -> Piece -> ShowS

show :: Piece -> String

showList :: [Piece] -> ShowS

NFData Piece

Defined in Toml.Type.Key

Methods

rnf :: Piece -> ()

Eq Piece

Defined in Toml.Type.Key

Methods

(==) :: Piece -> Piece -> Bool

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

Ord Piece

Defined in Toml.Type.Key

Methods

compare :: Piece -> Piece -> Ordering

(<) :: Piece -> Piece -> Bool

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

(>) :: Piece -> Piece -> Bool

(>=) :: Piece -> Piece -> Bool

max :: Piece -> Piece -> Piece

min :: Piece -> Piece -> Piece

Hashable Piece

Defined in Toml.Type.Key

Methods

hashWithSalt :: Int -> Piece -> Int

hash :: Piece -> Int

type Rep Piece

Defined in Toml.Type.Key

type Rep Piece = D1 ('MetaData "Piece" "Toml.Type.Key" "tomland-1.3.3.2-JRrBhNpiCh26pzVBpYNNR0" 'True) (C1 ('MetaCons "Piece" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPiece") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

pattern (:||) :: Piece -> [Piece] -> Key

Bidirectional pattern synonym for constructing and deconstructing Keys.

(<|) :: Piece -> Key -> Key

Prepends Piece to the beginning of the Key.

Key difference

data KeysDiff

Data represent difference between two keys.

Since: 0.0.0

Constructors

Equal

Keys are equal

NoPrefix

Keys don't have any common part.

FstIsPref

The first key is the prefix of the second one.

Fields

• !Key

  Rest of the second key.

SndIsPref

The second key is the prefix of the first one.

Fields

• !Key

  Rest of the first key.

Diff

Key have a common prefix.

Fields

• !Key

  Common prefix.

• !Key

  Rest of the first key.

• !Key

  Rest of the second key.

Instances

Show KeysDiff

Defined in Toml.Type.Key

Methods

showsPrec :: Int -> KeysDiff -> ShowS

show :: KeysDiff -> String

showList :: [KeysDiff] -> ShowS

Eq KeysDiff

Defined in Toml.Type.Key

Methods

(==) :: KeysDiff -> KeysDiff -> Bool

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

keysDiff :: Key -> Key -> KeysDiff

Find key difference between two keys.

Since: 0.0.0