streamly/core/src/Streamly/FileSystem/Path/Seg.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.Seg
-- Copyright   : (c) 2023 Composewell Technologies
-- License     : BSD3
-- Maintainer  : streamly@composewell.com
-- Portability : GHC
--
-- Represent 'Rooted' or 'Branch' type path segments explicitly as separate
-- types for the safety of path append operation. A Rooted path is an absolute
-- path or a path that is relative to the current directory with a leading dot.
-- Rooted paths cannot be appended to other paths.
--
-- See the overview in the "Streamly.FileSystem.Path" module for more details.
--
module Streamly.FileSystem.Path.Seg
    (
    -- * Types
      Rooted
    , Branch
    , IsSeg

    -- * Statically Verified Path Literals
    -- | Quasiquoters.
    , rt
    , br

    -- * Statically Verified Path Strings
    -- | Template Haskell expression splices.
    , rtE
    , brE

    -- * Operations
    , extend
    )
where

import Streamly.Internal.FileSystem.Path.Seg