hashed-storage-0.3.3.2: Hashed file storage support code. Source code Contents Index

Storage.Hashed.AnchoredPath

Contents Unsafe functions.

Description

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).

Synopsis

newtype Name = Name ByteString newtype AnchoredPath = AnchoredPath [Name] appendPath :: AnchoredPath -> Name -> AnchoredPath anchorPath :: FilePath -> AnchoredPath -> FilePath isPrefix :: AnchoredPath -> AnchoredPath -> Bool parent :: AnchoredPath -> AnchoredPath parents :: AnchoredPath -> [AnchoredPath] catPaths :: AnchoredPath -> AnchoredPath -> AnchoredPath flatten :: AnchoredPath -> ByteString makeName :: String -> Name nameToFilePath :: Name -> FilePath nameFromFilePath :: FilePath -> Name floatBS :: ByteString -> AnchoredPath

Documentation

newtype Name Source

Constructors Name ByteString Instances Eq Name Ord Name Show Name

newtype AnchoredPath Source

Constructors AnchoredPath [Name] Instances Eq AnchoredPath Ord AnchoredPath Show AnchoredPath

appendPath :: AnchoredPath -> Name -> AnchoredPath Source

Append an element to the end of a path.

anchorPath :: FilePath -> AnchoredPath -> FilePath Source

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 Source

Check whether a path is a prefix of another path.

parent :: AnchoredPath -> AnchoredPath Source

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

parents :: AnchoredPath -> [AnchoredPath] Source

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

catPaths :: AnchoredPath -> AnchoredPath -> AnchoredPath Source

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 Source

makeName :: String -> Name Source

Unsafe functions.

nameToFilePath :: Name -> FilePath Source

Unsafe.

nameFromFilePath :: FilePath -> Name Source

Unsafe.

floatBS :: ByteString -> AnchoredPath Source

Produced by Haddock version 2.4.2