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

Streamly.Internal.FileSystem.PosixPath.Seg

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 rooted paths and branches. Rooted paths are represented by the Rooted PosixPath type and branches are represented by the Unrooted PosixPath type. Rooted paths are paths that are attached to specific roots in the file system. Rooted paths could be absolute or relative e.g. /usr/bin, ./local/bin, or .. Unrootedes are a paths that are not attached to a specific root e.g. usr/bin, local/bin, or ../bin are branches.

This distinction provides a safe path append operation which cannot fail. These types do not allow appending a rooted path to any other path. Only branches can be appended.

Synopsis

newtype Rooted a = Rooted a
newtype Unrooted a = Unrooted a
class IsSeg a
rt :: QuasiQuoter
ur :: QuasiQuoter
rtE :: String -> Q Exp
urE :: String -> Q Exp
join :: (IsSeg (a PosixPath), IsPath PosixPath (a PosixPath)) => a PosixPath -> Unrooted PosixPath -> a PosixPath

Types

newtype Rooted a Source #

Constructors

Rooted a

Instances

Instances details

IsPath PosixPath (Rooted PosixPath) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg Methods unsafeFromPath :: PosixPath -> Rooted PosixPath Source # fromPath :: MonadThrow m => PosixPath -> m (Rooted PosixPath) Source # toPath :: Rooted 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 (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 #
IsSeg (Rooted a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg

newtype Unrooted a Source #

Constructors

Unrooted a

Instances

Instances details

IsPath PosixPath (Unrooted PosixPath) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg Methods unsafeFromPath :: PosixPath -> Unrooted PosixPath Source # fromPath :: MonadThrow m => PosixPath -> m (Unrooted PosixPath) Source # toPath :: Unrooted 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 #
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 #
IsSeg (Unrooted a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg

class IsSeg a Source #

Constraint to check if a type has Rooted or Unrooted annotations.

Instances

Instances details

IsSeg (Rooted a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg
IsSeg (Unrooted a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg

Statically Verified Path Literals

Quasiquoters.

rt :: QuasiQuoter Source #

Generates a Rooted Path type from a quoted literal.

>>> Path.toString (Path.toPath ([rt|/usr|] :: Rooted PosixPath))
"/usr"

ur :: QuasiQuoter Source #

Generates a Unrooted Path type from a quoted literal.

>>> Path.toString (Path.toPath ([ur|usr|] :: Unrooted PosixPath))
"usr"

Statically Verified Path Strings

Template Haskell expression splices.

rtE :: String -> Q Exp Source #

Generates a Haskell expression of type Rooted PosixPath.

urE :: String -> Q Exp Source #

Generates a Haskell expression of type Unrooted PosixPath.

Operations

join :: (IsSeg (a PosixPath), IsPath PosixPath (a PosixPath)) => a PosixPath -> Unrooted PosixPath -> a PosixPath Source #

Append a Unrooted type path to a Rooted path or Unrooted path.

>>> Path.toString (Path.toPath (Seg.join [rt|/usr|] [ur|bin|] :: Rooted PosixPath))
"/usr/bin"
>>> Path.toString (Path.toPath (Seg.join [ur|usr|] [ur|bin|] :: Unrooted PosixPath))
"usr/bin"