Streamly.Internal.FileSystem.PosixPath.Seg

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 Branch 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 .. Branches 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.

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 Branch a Source #

Constructors

Branch a

Instances

Instances details

IsPath PosixPath (Branch PosixPath) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg Methods unsafeFromPath :: PosixPath -> Branch PosixPath Source # fromPath :: MonadThrow m => PosixPath -> m (Branch PosixPath) Source # toPath :: Branch PosixPath -> PosixPath Source #
IsPath PosixPath (Branch (Dir PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Branch (Dir PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Branch (Dir PosixPath)) Source # toPath :: Branch (Dir PosixPath) -> PosixPath Source #
IsPath PosixPath (Branch (File PosixPath)) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.SegNode Methods unsafeFromPath :: PosixPath -> Branch (File PosixPath) Source # fromPath :: MonadThrow m => PosixPath -> m (Branch (File PosixPath)) Source # toPath :: Branch (File PosixPath) -> PosixPath Source #
IsSeg (Branch a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg

class IsSeg a Source #

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

Instances

Instances details

IsSeg (Branch a) Source #
Instance details Defined in Streamly.Internal.FileSystem.PosixPath.Seg
IsSeg (Rooted 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 ([rt|/usr|] :: Rooted PosixPath)
"/usr"

br :: QuasiQuoter Source #

Generates a Branch Path type from a quoted literal.

>>> Path.toString ([br|usr|] :: Branch PosixPath)
"usr"

Statically Verified Path Strings

Template Haskell expression splices.

rtE :: String -> Q Exp Source #

Generates a Haskell expression of type Rooted PosixPath.

brE :: String -> Q Exp Source #

Generates a Haskell expression of type Branch PosixPath.

Operations

append :: (IsSeg (a PosixPath), IsPath PosixPath (a PosixPath)) => a PosixPath -> Branch PosixPath -> a PosixPath Source #

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

>>> Path.toString (Seg.append [rt|/usr|] [br|bin|] :: Rooted PosixPath)
"/usr/bin"
>>> Path.toString (Seg.append [br|usr|] [br|bin|] :: Branch PosixPath)
"usr/bin"