Data.Separated

Documentation

data Separated s a

Constructors

Separated a [(s, a)]

Instances

Functor (Separated s)

Map across a Separated on the element values.

fmap id (x :: Separated Int String) == x

>>> fmap (+1) (single 1)
[2]

>>> fmap (+1) (set separatedTail [('a', 2), ('b', 3)] (single 1))
[2'a'3'b'4]

(Eq s, Eq a) => Eq (Separated s a)

(Ord s, Ord a) => Ord (Separated s a)

(Show s, Show a) => Show (Separated s a)

(~>) :: (s, a) -> Separated s a -> Separated s a

Prepend a separator and element to the current tail.

>>> ('b', 9) ~> ('a', 8) ~> single 7
[7'b'9'a'8]

single :: a -> Separated s a

>>> single 4
[4]

single x ^. separatedTail == []

separatedValues1 :: Separated s a -> NonEmpty a

Return all element values.

>>> separatedValues1 (single 8)
8 :| []

>>> separatedValues1 (('a', 9) ~> single 8)
8 :| [9]

let h :| _ = separatedValues1 (single x) in h == (x :: Int)

let _ :| t = separatedValues1 (e ~> single x) in t == fmap fst [e]

separatedValues :: Separated s a -> [a]

Return all element values.

>>> separatedValues (single 8)
[8]

>>> separatedValues (('a', 9) ~> single 8)
[8,9]

let h : _ = separatedValues (single x) in h == (x :: Int)

let _ : t = separatedValues (e ~> single x) in t == fmap fst [e]

separatedHead :: Lens' (Separated s a) a

A lens on the first element value.

>>> single 7 ^. separatedHead
7

single x ^. separatedHead == (x :: Int)

separatedTail :: Lens' (Separated s a) [(s, a)]

A lens on the tail.

>>> single 7 ^. separatedHead
7

(e ~> single x) ^. separatedTail == [e]

separators :: Separated s a -> [s]

Return all separator values.

>>> separators (('a', 8) ~> single 7)
"a"

>>> separators (('b', 9) ~> ('a', 8) ~> single 7)
"ba"

separators (single x) == []