circuithub/rel8
1
1
Fork 0
mirror of https://github.com/circuithub/rel8.git synced 2024-10-27 02:08:37 +03:00
Code Issues Projects Releases Wiki Activity

Expand documentation of Rel8.Table.These combinators

Browse Source
This commit is contained in:
Shane O'Brien 2021-06-18 17:13:31 +01:00
parent 760dcd82f8
commit bff98fedbd
No known key found for this signature in database
GPG Key ID: 35A00ED1B695C1A1
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/Rel8/Table/These.hs
View File

@ -188,36 +188,50 @@ toThereTag Tag {..} = Tag {..}
-- | Test if a 'TheseTable' was constructed with 'thisTable'.
--
-- Corresponds to 'Data.These.Combinators.isThis'.
isThisTable :: TheseTable a b -> Expr Bool
isThisTable a = hasHereTable a &&. not_ (hasThereTable a)
-- | Test if a 'TheseTable' was constructed with 'thatTable'.
--
-- Corresponds to 'Data.These.Combinators.isThat'.
isThatTable :: TheseTable a b -> Expr Bool
isThatTable a = not_ (hasHereTable a) &&. hasThereTable a
-- | Test if a 'TheseTable' was constructed with 'thoseTable'.
--
-- Corresponds to 'Data.These.Combinators.isThese'.
isThoseTable :: TheseTable a b -> Expr Bool
isThoseTable a = hasHereTable a &&. hasThereTable a
-- | Test if the @a@ table of @TheseTable a b@ is present.
-- | Test if the @a@ side of @TheseTable a b@ is present.
--
-- Corresponds to 'Data.These.Combinators.hasHere'.
hasHereTable :: TheseTable a b -> Expr Bool
hasHereTable TheseTable {here} = isJustTable here
-- | Test if the @b@ table of @TheseTable a b@ is present.
--
-- Corresponds to 'Data.These.Combinators.hasThere'.
hasThereTable :: TheseTable a b -> Expr Bool
hasThereTable TheseTable {there} = isJustTable there
-- | Attempt to project out the @a@ table of a @TheseTable a b@.
--
-- Corresponds to 'Data.These.Combinators.justHere'.
justHereTable :: TheseTable a b -> MaybeTable a
justHereTable = here
-- | Attempt to project out the @b@ table of a @TheseTable a b@.
--
-- Corresponds to 'Data.These.Combinators.justThere'.
justThereTable :: TheseTable a b -> MaybeTable b
justThereTable = there
@ -237,7 +251,7 @@ thoseTable :: a -> b -> TheseTable a b
thoseTable a b = TheseTable (justTable a) (justTable b)
-- | Pattern match on a 'TheseTable'.
-- | Pattern match on a 'TheseTable'. Corresponds to 'these'.
theseTable :: Table Expr c
=> (a -> c) -> (b -> c) -> (a -> b -> c) -> TheseTable a b -> c
theseTable f g h TheseTable {here, there} =
@ -252,9 +266,9 @@ theseTable f g h TheseTable {here, there} =
-- 'TableSchema'.
nameTheseTable :: ()
=> Name (Maybe MaybeTag)
-- ^ The name of the column to track the presence of 'thisTable'.
-- ^ The name of the column to track the presence of the @a@ table.
-> Name (Maybe MaybeTag)
-- ^ The name of the column to track the presence of 'thatTable'.
-- ^ The name of the column to track the presence of the @b@ table.
-> a
-- ^ Names of the columns in the @a@ table.
-> b