streamly/core/src/Streamly/FileSystem/Path/Node.hs at 64a473f806952013801f701e825037c79a5d84c1 · composewell/streamly · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
-- |
-- Module      : Streamly.FileSystem.Path.Node
-- Copyright   : (c) 2023 Composewell Technologies
-- License     : BSD3
-- Maintainer  : streamly@composewell.com
-- Portability : GHC
--
-- Represent 'File' or 'Dir' type path nodes explicitly as separate types for
-- the safety of path append operation. A 'Dir' path is a branching or
-- intermediate node whereas a 'File' type is a terminal or leaf node. We
-- cannot append a path to a 'File' type path.
--
-- See the overview in the "Streamly.FileSystem.Path" module for more details.
--
module Streamly.FileSystem.Path.Node
    (
    -- * Types
      File
    , Dir
    , IsNode

    -- * Statically Verified Path Literals
    -- | Quasiquoters.
    , dir
    , file

    -- * Statically Verified Path Strings
    -- | Template Haskell expression splices.
    , dirE
    , fileE

    -- * Operations
    , extend
    )
where

import Streamly.Internal.FileSystem.Path.Node