Copyright	(c) 2023 Composewell Technologies
License	BSD3
Maintainer	streamly@composewell.com
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Streamly.Internal.FileSystem.PosixPath.Node

Contents

Types
Statically Verified Path Literals
Statically Verified Path Strings
Operations

Description

This module provides a type safe path append operation by distinguishing paths between files and directories. Files are represented by the File PosixPath type and directories are represented by the Dir PosixPath type.

This distinction provides safety against appending a path to a file. Append operation allows appending to only Dir types.

Synopsis

newtype File a = File a
newtype Dir a = Dir a
class IsNode a
dir :: QuasiQuoter
file :: QuasiQuoter
dirE :: String -> Q Exp
fileE :: String -> Q Exp
join :: (IsPath PosixPath (a PosixPath), IsNode (a PosixPath)) => Dir PosixPath -> a PosixPath -> a PosixPath

Types

newtype File a Source #

Constructors

File a

Instances

Instances details

IsPath PosixPath (File PosixPath) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node Methods unsafeFromPath :: PosixPath -> File PosixPath Source # fromPath :: MonadThrow m => PosixPath -> m (File PosixPath) Source # toPath :: File PosixPath -> PosixPath Source #
IsPath PosixPath (Rooted (File PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Rooted (File PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Rooted (File PosixPath)) Source # toPath :: Rooted (File PosixPath) -> PosixPath Source #
IsPath PosixPath (Unrooted (File PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Unrooted (File PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Unrooted (File PosixPath)) Source # toPath :: Unrooted (File PosixPath) -> PosixPath Source #
IsNode (File a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node

newtype Dir a Source #

Constructors

Dir a

Instances

Instances details

IsPath PosixPath (Dir PosixPath) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node Methods unsafeFromPath :: PosixPath -> Dir PosixPath Source # fromPath :: MonadThrow m => PosixPath -> m (Dir PosixPath) Source # toPath :: Dir PosixPath -> PosixPath Source #
IsPath PosixPath (Rooted (Dir PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Rooted (Dir PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Rooted (Dir PosixPath)) Source # toPath :: Rooted (Dir PosixPath) -> PosixPath Source #
IsPath PosixPath (Unrooted (Dir PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Unrooted (Dir PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Unrooted (Dir PosixPath)) Source # toPath :: Unrooted (Dir PosixPath) -> PosixPath Source #
IsNode (Dir a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node

class IsNode a Source #

Constraint to check if a type uses File or Dir as the outermost constructor.

Instances

Instances details

IsNode (Dir a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node
IsNode (File a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Node

Statically Verified Path Literals

Quasiquoters.

dir :: QuasiQuoter Source #

Generates a Dir PosixPath type from a quoted literal.

>>> Path.toString (Path.toPath ([dir|usr|] :: Dir PosixPath))
"usr"

file :: QuasiQuoter Source #

Generates a File PosixPath type from a quoted literal.

>>> Path.toString (Path.toPath ([file|usr|] :: File PosixPath))
"usr"

Statically Verified Path Strings

Template Haskell expression splices.

dirE :: String -> Q Exp Source #

Generates a Haskell expression of type Dir PosixPath.

fileE :: String -> Q Exp Source #

Generates a Haskell expression of type File PosixPath.

Operations

join :: (IsPath PosixPath (a PosixPath), IsNode (a PosixPath)) => Dir PosixPath -> a PosixPath -> a PosixPath Source #

Append a Dir or File path to a Dir path.

>>> Path.toString (Path.toPath (Node.join [dir|/usr|] [dir|bin|] :: Dir PosixPath))
"/usr/bin"
>>> Path.toString (Path.toPath (Node.join [dir|/usr|] [file|bin|] :: File PosixPath))
"/usr/bin"

Fails if the second path is a specific location and not a path segment.