Storage.Hashed.AnchoredPath

This module implements relative paths within a Tree. All paths are anchored at a certain root (this is usually the Tree root). They are represented by a list of Names (these are just strict bytestrings).

Documentation

newtype Name

Constructors

Name ByteString

Instances

Eq Name

Ord Name

Show Name

newtype AnchoredPath

Constructors

AnchoredPath [Name]

Instances

Eq AnchoredPath

Ord AnchoredPath

Show AnchoredPath

anchoredRoot :: AnchoredPath

appendPath :: AnchoredPath -> Name -> AnchoredPath

Append an element to the end of a path.

anchorPath :: FilePath -> AnchoredPath -> FilePath

Take a root directory and an anchored path and produce a full FilePath. Moreover, you can use anchorPath "" to get a relative FilePath.

isPrefix :: AnchoredPath -> AnchoredPath -> Bool

Check whether a path is a prefix of another path.

parent :: AnchoredPath -> AnchoredPath

Get parent (path) of a given path. foobarbaz -> foo/bar

parents :: AnchoredPath -> [AnchoredPath]

List all parents of a given path. foobarbaz -> [foo, foo/bar]

catPaths :: AnchoredPath -> AnchoredPath -> AnchoredPath

Catenate two paths together. Not very safe, but sometimes useful (e.g. when you are representing paths relative to a different point than a Tree root).

flatten :: AnchoredPath -> ByteString

makeName :: String -> Name

Unsafe functions.

floatBS :: ByteString -> AnchoredPath

floatPath :: FilePath -> AnchoredPath

Take a relative FilePath and turn it into an AnchoredPath. The operation is unsafe and if you break it, you keep both pieces. More useful for exploratory purposes (ghci) than for serious programming.