Open
Description
First suggested in #72 (comment). FsPath
has a number of invariants, and we currently rely on the user to satisfy them. It might be nice to check these invariants dynamically, while also providing an escape hatch for users in case they want to skip the check. For example:
newtype FsPath = UnsafeFsPath { fsPathToList :: [Strict.Text] }
deriving (Eq, Ord, Generic)
deriving newtype NFData
invariant :: FsPath -> Bool
invariant (UnsafeFsPath xs) = all p xs
where p x = -- Paths are monotonic
x /= ".."
&& -- Paths can not have empty directory/file names
not (any Strict.null xs)
&& -- There are no path separators in individual names
not (Text.any (`Text.elem` allPathSeparators) x)
allPathSeparators :: Text
allPathSeparators = Text.pack (Posix.pathSeparators ++ Windows.pathSeparators)
unsafeFsPathFromList :: [Strict.Text] -> FsPath
unsafeFsPathFromList xs = assert (invariant fsp) $ fsp
where fsp = UnsafeFsPath (force xs)
fsPathFromList :: [Strict.Text] -> Maybe FsPath
fsPathFromList xs
| invariant fsp = Just fsp
| otherwise = Nothing
where fsp = UnsafeFsPath (force xs)
Note two things in the example above:
- Both
unsafeFsPathFromList
andfsPathFromList
ensure that the resultingFsPath
contains no thunks my usingforce
. Maybe we want toassert
instead that theFsPath
contains no thunks inunsafeFsPathFromList
, and have the user ensure that fact. - To ensure similar behaviour across OS distributions, invariant checks do not depend on the underlying OS distribution, hence
allPathSeparators
.
We should also consider whether this design pattern is overkill: in practice, users are probably unlikely to use non-sensible path names
Metadata
Metadata
Assignees
Labels
No labels