Copyright	(c) 2024 Illia Shkroba
License	BSD3
Maintainer	Illia Shkroba <[email protected]>
Stability	unstable
Portability	non-portable (Non-Unix systems are not supported)
Safe Haskell	Safe-Inferred
Language	Haskell2010

PFile.Path

Description

Wrapper of Directory and FilePath.

Synopsis

findDirectories :: MonadIO m => Absolute -> m [Absolute]
findFiles :: MonadIO m => Absolute -> m [Absolute]
find :: forall m. MonadIO m => Absolute -> m FindResult
data FindResult = FindResult {
- files :: !(HashSet Absolute)
- dirs :: !(HashSet Absolute)
}
(<//>) :: Absolute -> FilePath -> Absolute
parseAbsolute :: MonadIO m => FilePath -> m (Maybe Absolute)
canonicalizePath :: MonadIO m => Absolute -> m Absolute
copy :: (MonadError CopyError m, MonadIO m) => Absolute -> Absolute -> m ()
copyDirectory :: (MonadError CopyError m, MonadIO m) => Absolute -> Absolute -> m ()
copyDirectoryLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
copyFile :: (MonadError CopyFileError m, MonadIO m) => Absolute -> Absolute -> m ()
copyFileLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
copyLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
showCopyError :: CopyError -> Text
data CopyError
- = SourceTypeResolveCopyError !Absolute
- | ListDirectoryError !Absolute !IOException
- | CreateDirectoryInCopyError !CreateDirectoryError
- | CopyLinkError !CopyLinkError
- | CopyFileError !CopyFileError
showCopyLinkError :: CopyLinkError -> Text
data CopyLinkError
- = CreateParentInCopyLinkError !CreateParentError
- | LinkTargetResolveError !Absolute !IOException
- | CreateDirectoryLinkInCopyLinkError !CreateDirectoryLinkError
- | CreateFileLinkInCopyLinkError !CreateFileLinkError
showCopyFileError :: CopyFileError -> Text
data CopyFileError
- = CreateParentInCopyFileError !CreateParentError
- | CopyFileWithMetadataError !Absolute !Absolute !IOException
createDirectory :: (MonadError CreateDirectoryError m, MonadIO m) => Absolute -> m ()
showCreateDirectoryError :: CreateDirectoryError -> Text
data CreateDirectoryError = CreateDirectoryError !Absolute !IOException
createDirectoryLink :: (MonadError CreateDirectoryLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
showCreateDirectoryLinkError :: CreateDirectoryLinkError -> Text
data CreateDirectoryLinkError
- = CreateParentInCreateDirectoryLinkError !CreateParentError
- | CreateDirectoryLinkError !Absolute !Absolute !IOException
createEmptyFile :: (MonadError WriteFileError m, MonadIO m) => Absolute -> m ()
createFileLink :: (MonadError CreateFileLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
showCreateFileLinkError :: CreateFileLinkError -> Text
data CreateFileLinkError
- = CreateParentInCreateFileLinkError !CreateParentError
- | CreateFileLinkError !Absolute !Absolute !IOException
createLink :: (MonadError CreateLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
showCreateLinkError :: CreateLinkError -> Text
data CreateLinkError
- = DirectoryLinkError !CreateDirectoryLinkError
- | FileLinkError !CreateFileLinkError
createParent :: (MonadError CreateParentError m, MonadIO m) => Absolute -> m ()
showCreateParentError :: CreateParentError -> Text
data CreateParentError = CreateParentError !Absolute !CreateDirectoryError
doesDirectoryExist :: MonadIO m => Absolute -> m Bool
doesFileExist :: MonadIO m => Absolute -> m Bool
doesPathExist :: MonadIO m => Absolute -> m Bool
dropDrive :: Absolute -> FilePath
dropFileName :: Absolute -> Absolute
dropTrailingPathSeparator :: Absolute -> Absolute
getSymbolicLinkTarget :: MonadIO m => Absolute -> m Absolute
listDirectory :: MonadIO m => Absolute -> m [Absolute]
makeRelative :: Absolute -> Absolute -> FilePath
move :: (MonadError MoveError m, MonadIO m) => Absolute -> Absolute -> m ()
moveDirectory :: (MonadError MoveDirectoryError m, MonadIO m) => Absolute -> Absolute -> m ()
moveDirectoryLink :: (MonadError MoveDirectoryLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
moveFile :: (MonadError MoveFileError m, MonadIO m) => Absolute -> Absolute -> m ()
moveFileLink :: (MonadError MoveFileLinkError m, MonadIO m) => Absolute -> Absolute -> m ()
showMoveError :: MoveError -> Text
data MoveError
- = SourceTypeResolveMoveError !Absolute
- | MoveDirectoryError !MoveDirectoryError
- | MoveDirectoryLinkError !MoveDirectoryLinkError
- | MoveFileError !MoveFileError
- | MoveFileLinkError !MoveFileLinkError
showMoveDirectoryError :: MoveDirectoryError -> Text
data MoveDirectoryError
- = CreateParentInMoveDirectoryError !CreateParentError
- | FallbackCopyDirectoryError !CopyError
- | SourceDirectoryRemoveError !RemoveError
- | RenameDirectoryError !Absolute !Absolute !IOException
showMoveDirectoryLinkError :: MoveDirectoryLinkError -> Text
data MoveDirectoryLinkError
- = CreateParentInMoveDirectoryLinkError !CreateParentError
- | FallbackCopyDirectoryLinkError !CopyLinkError
- | SourceDirectoryLinkRemoveError !RemoveError
- | RenameDirectoryLinkError !Absolute !Absolute !IOException
showMoveFileError :: MoveFileError -> Text
data MoveFileError
- = CreateParentInMoveFileError !CreateParentError
- | FallbackCopyFileError !CopyFileError
- | SourceFileRemoveError !RemoveError
- | RenameFileError !Absolute !Absolute !IOException
showMoveFileLinkError :: MoveFileLinkError -> Text
data MoveFileLinkError
- = CreateParentInMoveFileLinkError !CreateParentError
- | FallbackCopyFileLinkError !CopyLinkError
- | SourceFileLinkRemoveError !RemoveError
- | RenameFileLinkError !Absolute !Absolute !IOException
pathIsSymbolicLink :: MonadIO m => Absolute -> m Bool
remove :: (MonadError RemoveError m, MonadIO m) => Absolute -> m ()
showRemoveError :: RemoveError -> Text
data RemoveError
- = RemoveDirectoryError !Absolute !IOException
- | RemoveDirectoryLinkError !Absolute !IOException
- | RemoveFileError !Absolute !IOException
- | RemoveFileLinkError !Absolute !IOException
renameDirectory :: MonadIO m => Absolute -> Absolute -> m ()
renameFile :: MonadIO m => Absolute -> Absolute -> m ()
takeBaseName :: Absolute -> FilePath
typeOf :: MonadIO m => Absolute -> m (Maybe Type)
showType :: Type -> Text
data Type
- = Directory
- | DirectoryLink
- | File
- | FileLink
writeFile :: (MonadError WriteFileError m, MonadIO m) => Absolute -> Text -> m ()
showWriteFileError :: WriteFileError -> Text
data WriteFileError
- = CreateParentInWriteFileError !CreateParentError
- | WriteFileError !Absolute !IOException
showAbsolute :: Absolute -> Text
newtype Absolute = Absolute {
- unAbsolute :: FilePath
}

Documentation

findDirectories :: MonadIO m => Absolute -> m [Absolute] Source #

findFiles :: MonadIO m => Absolute -> m [Absolute] Source #

find :: forall m. MonadIO m => Absolute -> m FindResult Source #

data FindResult Source #

Constructors

FindResult
Fields files :: !(HashSet Absolute) dirs :: !(HashSet Absolute)

(<//>) :: Absolute -> FilePath -> Absolute infixr 5 Source #

parseAbsolute :: MonadIO m => FilePath -> m (Maybe Absolute) Source #

canonicalizePath :: MonadIO m => Absolute -> m Absolute Source #

copy :: (MonadError CopyError m, MonadIO m) => Absolute -> Absolute -> m () Source #

copyDirectory :: (MonadError CopyError m, MonadIO m) => Absolute -> Absolute -> m () Source #

copyDirectoryLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

copyFile :: (MonadError CopyFileError m, MonadIO m) => Absolute -> Absolute -> m () Source #

copyFileLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

copyLink :: (MonadError CopyLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

showCopyError :: CopyError -> Text Source #

data CopyError Source #

Constructors

SourceTypeResolveCopyError !Absolute
ListDirectoryError !Absolute !IOException
CreateDirectoryInCopyError !CreateDirectoryError
CopyLinkError !CopyLinkError
CopyFileError !CopyFileError

showCopyLinkError :: CopyLinkError -> Text Source #

data CopyLinkError Source #

Constructors

CreateParentInCopyLinkError !CreateParentError
LinkTargetResolveError !Absolute !IOException
CreateDirectoryLinkInCopyLinkError !CreateDirectoryLinkError
CreateFileLinkInCopyLinkError !CreateFileLinkError

showCopyFileError :: CopyFileError -> Text Source #

data CopyFileError Source #

Constructors

CreateParentInCopyFileError !CreateParentError
CopyFileWithMetadataError !Absolute !Absolute !IOException

createDirectory :: (MonadError CreateDirectoryError m, MonadIO m) => Absolute -> m () Source #

showCreateDirectoryError :: CreateDirectoryError -> Text Source #

data CreateDirectoryError Source #

Constructors

CreateDirectoryError !Absolute !IOException

createDirectoryLink :: (MonadError CreateDirectoryLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

showCreateDirectoryLinkError :: CreateDirectoryLinkError -> Text Source #

data CreateDirectoryLinkError Source #

Constructors

CreateParentInCreateDirectoryLinkError !CreateParentError
CreateDirectoryLinkError !Absolute !Absolute !IOException

createEmptyFile :: (MonadError WriteFileError m, MonadIO m) => Absolute -> m () Source #

createFileLink :: (MonadError CreateFileLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

showCreateFileLinkError :: CreateFileLinkError -> Text Source #

data CreateFileLinkError Source #

Constructors

CreateParentInCreateFileLinkError !CreateParentError
CreateFileLinkError !Absolute !Absolute !IOException

createLink :: (MonadError CreateLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

showCreateLinkError :: CreateLinkError -> Text Source #

data CreateLinkError Source #

Constructors

DirectoryLinkError !CreateDirectoryLinkError
FileLinkError !CreateFileLinkError

createParent :: (MonadError CreateParentError m, MonadIO m) => Absolute -> m () Source #

showCreateParentError :: CreateParentError -> Text Source #

data CreateParentError Source #

Constructors

CreateParentError !Absolute !CreateDirectoryError

doesDirectoryExist :: MonadIO m => Absolute -> m Bool Source #

doesFileExist :: MonadIO m => Absolute -> m Bool Source #

doesPathExist :: MonadIO m => Absolute -> m Bool Source #

dropDrive :: Absolute -> FilePath Source #

dropFileName :: Absolute -> Absolute Source #

dropTrailingPathSeparator :: Absolute -> Absolute Source #

getSymbolicLinkTarget :: MonadIO m => Absolute -> m Absolute Source #

listDirectory :: MonadIO m => Absolute -> m [Absolute] Source #

makeRelative :: Absolute -> Absolute -> FilePath Source #

move :: (MonadError MoveError m, MonadIO m) => Absolute -> Absolute -> m () Source #

moveDirectory :: (MonadError MoveDirectoryError m, MonadIO m) => Absolute -> Absolute -> m () Source #

moveDirectoryLink :: (MonadError MoveDirectoryLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

moveFile :: (MonadError MoveFileError m, MonadIO m) => Absolute -> Absolute -> m () Source #

moveFileLink :: (MonadError MoveFileLinkError m, MonadIO m) => Absolute -> Absolute -> m () Source #

showMoveError :: MoveError -> Text Source #

data MoveError Source #

Constructors

SourceTypeResolveMoveError !Absolute
MoveDirectoryError !MoveDirectoryError
MoveDirectoryLinkError !MoveDirectoryLinkError
MoveFileError !MoveFileError
MoveFileLinkError !MoveFileLinkError

showMoveDirectoryError :: MoveDirectoryError -> Text Source #

data MoveDirectoryError Source #

Constructors

CreateParentInMoveDirectoryError !CreateParentError
FallbackCopyDirectoryError !CopyError
SourceDirectoryRemoveError !RemoveError
RenameDirectoryError !Absolute !Absolute !IOException

showMoveDirectoryLinkError :: MoveDirectoryLinkError -> Text Source #

data MoveDirectoryLinkError Source #

Constructors

CreateParentInMoveDirectoryLinkError !CreateParentError
FallbackCopyDirectoryLinkError !CopyLinkError
SourceDirectoryLinkRemoveError !RemoveError
RenameDirectoryLinkError !Absolute !Absolute !IOException

showMoveFileError :: MoveFileError -> Text Source #

data MoveFileError Source #

Constructors

CreateParentInMoveFileError !CreateParentError
FallbackCopyFileError !CopyFileError
SourceFileRemoveError !RemoveError
RenameFileError !Absolute !Absolute !IOException

showMoveFileLinkError :: MoveFileLinkError -> Text Source #

data MoveFileLinkError Source #

Constructors

CreateParentInMoveFileLinkError !CreateParentError
FallbackCopyFileLinkError !CopyLinkError
SourceFileLinkRemoveError !RemoveError
RenameFileLinkError !Absolute !Absolute !IOException

pathIsSymbolicLink :: MonadIO m => Absolute -> m Bool Source #

remove :: (MonadError RemoveError m, MonadIO m) => Absolute -> m () Source #

remove should be used instead of the removePathForcibly to properly remove a path without messing up permissions of a target in case of links

showRemoveError :: RemoveError -> Text Source #

data RemoveError Source #

Constructors

RemoveDirectoryError !Absolute !IOException
RemoveDirectoryLinkError !Absolute !IOException
RemoveFileError !Absolute !IOException
RemoveFileLinkError !Absolute !IOException

renameDirectory :: MonadIO m => Absolute -> Absolute -> m () Source #

renameFile :: MonadIO m => Absolute -> Absolute -> m () Source #

takeBaseName :: Absolute -> FilePath Source #

typeOf :: MonadIO m => Absolute -> m (Maybe Type) Source #

showType :: Type -> Text Source #

data Type Source #

Constructors

Directory
DirectoryLink
File
FileLink

writeFile :: (MonadError WriteFileError m, MonadIO m) => Absolute -> Text -> m () Source #

showWriteFileError :: WriteFileError -> Text Source #

data WriteFileError Source #

Constructors

CreateParentInWriteFileError !CreateParentError
WriteFileError !Absolute !IOException

showAbsolute :: Absolute -> Text Source #

newtype Absolute Source #

Absolute FilePath to a filesystem's object.

Since: 0.1.0.0

Constructors

Absolute
Fields unAbsolute :: FilePath

Instances

Instances details

FromJSON Absolute Source #
Instance details Defined in PFile.Path Methods parseJSON :: Value -> Parser Absolute # parseJSONList :: Value -> Parser [Absolute] #
ToJSON Absolute Source #
Instance details Defined in PFile.Path Methods toJSON :: Absolute -> Value # toEncoding :: Absolute -> Encoding # toJSONList :: [Absolute] -> Value # toEncodingList :: [Absolute] -> Encoding #
Eq Absolute Source #
Instance details Defined in PFile.Path Methods (==) :: Absolute -> Absolute -> Bool # (/=) :: Absolute -> Absolute -> Bool #
Hashable Absolute Source #
Instance details Defined in PFile.Path Methods hashWithSalt :: Int -> Absolute -> Int # hash :: Absolute -> Int #