Safe Haskell	None
Language	GHC2021

FileSystem.Path

Contents

Pattern Synonym
QuasiQuoters
Operations
Parsing
Elimination
Re-exports

Description

Provides utilities for working with Path.

Since: 0.1

Synopsis

pattern MkPath :: OsPath -> Path b t
absdirPathSep :: QuasiQuoter
absfilePathSep :: QuasiQuoter
reldirPathSep :: QuasiQuoter
relfilePathSep :: QuasiQuoter
(<</>>) :: Path b Dir -> Path Rel t -> Path b t
addExtension :: (HasCallStack, MonadThrow m) => OsPath -> Path b File -> m (Path b File)
splitExtension :: (HasCallStack, MonadThrow m) => Path b File -> m (Path b File, OsPath)
fileExtension :: (HasCallStack, MonadThrow m) => Path b File -> m OsPath
replaceExtension :: (HasCallStack, MonadThrow m) => OsPath -> Path b File -> m (Path b File)
parseAbsDir :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Abs Dir)
parseAbsFile :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Abs File)
parseRelDir :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Rel Dir)
parseRelFile :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Rel File)
toOsPath :: Path b t -> OsPath
data Path b t
data Abs
data Rel
data Dir
data File

Pattern Synonym

pattern MkPath :: OsPath -> Path b t Source #

Pattern synonym for eliminating Path to OsPath.

Since: 0.1

QuasiQuoters

absdirPathSep :: QuasiQuoter Source #

Like absdir, except it runs paths through a "replace function" first. On unix, replaces \ with /. On windows, does the opposite.

Since: 0.1

absfilePathSep :: QuasiQuoter Source #

Like absfile, except it runs paths through a "replace function" first. On unix, replaces \ with /. On windows, does the opposite.

Since: 0.1

reldirPathSep :: QuasiQuoter Source #

Like reldir, except it runs paths through a "replace function" first. On unix, replaces \ with /. On windows, does the opposite.

Since: 0.1

relfilePathSep :: QuasiQuoter Source #

Like relfile, except it runs paths through a "replace function" first. On unix, replaces \ with /. On windows, does the opposite.

Since: 0.1

Operations

(<</>>) :: Path b Dir -> Path Rel t -> Path b t infixr 5 Source #

Alias for </>, intended to allow unqualified usage alongside OsPath's </>.

Since: 0.1

addExtension :: (HasCallStack, MonadThrow m) => OsPath -> Path b File -> m (Path b File) Source #

Like addExtension, but in terms of OsPath rather than system specific type.

Since: 0.1

splitExtension :: (HasCallStack, MonadThrow m) => Path b File -> m (Path b File, OsPath) Source #

Like splitExtension, but in terms of OsPath rather than system specific type.

Since: 0.1

fileExtension :: (HasCallStack, MonadThrow m) => Path b File -> m OsPath Source #

Like fileExtension, but in terms of OsPath rather than system specific type.

Since: 0.1

replaceExtension :: (HasCallStack, MonadThrow m) => OsPath -> Path b File -> m (Path b File) Source #

Like replaceExtension, but in terms of OsPath rather than system specific type.

Since: 0.1

Parsing

parseAbsDir :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Abs Dir) Source #

Like parseAbsDir, but in terms of OsPath rather than system specific type.

Since: 0.1

parseAbsFile :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Abs File) Source #

Like parseAbsFile, but in terms of OsPath rather than system specific type.

Since: 0.1

parseRelDir :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Rel Dir) Source #

Like parseRelDir, but in terms of OsPath rather than system specific type.

Since: 0.1

parseRelFile :: (HasCallStack, MonadThrow m) => OsPath -> m (Path Rel File) Source #

Like parseRelFile, but in terms of OsPath rather than system specific type.

Since: 0.1

Elimination

toOsPath :: Path b t -> OsPath Source #

Path to OsPath.

Since: 0.1

Re-exports

data Path b t #

Instances

Instances details

(Typeable b, Typeable t) => Lift (Path b t :: Type)

Instance details

Defined in OsPath.Internal.Posix

Methods

lift :: Quote m => Path b t -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Path b t -> Code m (Path b t) #

NFData (Path b t)

Instance details

Defined in OsPath.Internal.Posix

Methods

rnf :: Path b t -> () #

(Data b, Data t) => Data (Path b t)

Instance details

Defined in OsPath.Internal.Posix

Methods

gfoldl :: (forall d b0. Data d => c (d -> b0) -> d -> c b0) -> (forall g. g -> c g) -> Path b t -> c (Path b t) #

gunfold :: (forall b0 r. Data b0 => c (b0 -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Path b t) #

toConstr :: Path b t -> Constr #

dataTypeOf :: Path b t -> DataType #

dataCast1 :: Typeable t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (Path b t)) #

dataCast2 :: Typeable t0 => (forall d e. (Data d, Data e) => c (t0 d e)) -> Maybe (c (Path b t)) #

gmapT :: (forall b0. Data b0 => b0 -> b0) -> Path b t -> Path b t #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Path b t -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Path b t -> r #

gmapQ :: (forall d. Data d => d -> u) -> Path b t -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Path b t -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Path b t -> m (Path b t) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Path b t -> m (Path b t) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Path b t -> m (Path b t) #

Generic (Path b t)

Instance details

Defined in OsPath.Internal.Posix

Associated Types

type Rep (Path b t)
Instance details Defined in OsPath.Internal.Posix type Rep (Path b t) = D1 ('MetaData "Path" "OsPath.Internal.Posix" "path-0.9.6-8lSkXVZq0YHIsussDki9Tp" 'True) (C1 ('MetaCons "Path" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PosixPath)))