Safe Haskell	None
Language	Haskell2010

FoundationDB.Layer.Directory.Internal

Description

This module is a relatively direct translation of the official directory layer code in Python and Go.

Synopsis

_SUBDIRS :: Integer
majorVersion :: Word32
minorVersion :: Word32
microVersion :: Word32
throwing :: String -> Either a b -> Transaction b
data DirectoryLayer = DirectoryLayer {
- nodeSS :: Subspace
- contentSS :: Subspace
- allocator :: HCA
- rootNode :: Subspace
- allowManualPrefixes :: Bool
- dlPath :: [Text]
}
type Path = [Text]
data Directory = Directory {
- directorySubspace :: Subspace
- directoryPath :: Path
- directoryLayer :: ByteString
}
dirSubspace :: Directory -> Subspace
dirPath :: Directory -> Path
dirLayer :: Directory -> ByteString
data DirPartition = DirPartition {
- dirPartition :: DirectoryLayer
- dirPartitionParentDL :: DirectoryLayer
}
newDirectoryLayer :: Subspace -> Subspace -> Bool -> DirectoryLayer
defaultDirLayer :: DirectoryLayer
open :: DirectoryLayer -> Path -> Transaction (Maybe Directory)
createOrOpen :: DirectoryLayer -> Path -> Transaction Directory
open' :: DirectoryLayer -> Path -> ByteString -> Maybe ByteString -> Transaction (Maybe Directory)
createOrOpen' :: DirectoryLayer -> Path -> ByteString -> Maybe ByteString -> Transaction Directory
exists :: DirectoryLayer -> Path -> Transaction Bool
list :: DirectoryLayer -> Path -> Transaction (Seq Text)
data MoveError
- = SelfSubDir
- | SourceDoesNotExist
- | MoveBetweenPartitions
- | DestinationAlreadyExists
- | DestinationParentDoesNotExist
- | CannotMoveToRoot
move :: DirectoryLayer -> Path -> Path -> Transaction (Maybe MoveError)
remove :: DirectoryLayer -> Path -> Transaction Bool
removeRecursive :: DirectoryLayer -> Subspace -> Transaction ()
removeFromParent :: DirectoryLayer -> Path -> Transaction ()
subdirNameNodes :: DirectoryLayer -> Subspace -> Transaction (Seq (Text, Subspace))
subdirNames :: DirectoryLayer -> Subspace -> Transaction (Seq Text)
subdirNodes :: DirectoryLayer -> Subspace -> Transaction (Seq Subspace)
nodeContainingKey :: DirectoryLayer -> ByteString -> Transaction (Maybe Subspace)
isPrefixFree :: DirectoryLayer -> ByteString -> Transaction Bool
checkVersion :: DirectoryLayer -> Transaction ()
initializeDirectory :: DirectoryLayer -> Transaction ()
nodeWithPrefix :: DirectoryLayer -> ByteString -> Subspace
find :: DirectoryLayer -> Path -> Transaction (Maybe FoundNode)
contentsOfNodePartition :: DirectoryLayer -> Subspace -> Path -> Transaction DirPartition
contentsOfNodeSubspace :: DirectoryLayer -> Subspace -> Path -> ByteString -> Transaction Directory

Documentation

_SUBDIRS :: Integer Source #

majorVersion :: Word32 Source #

minorVersion :: Word32 Source #

microVersion :: Word32 Source #

throwing :: String -> Either a b -> Transaction b Source #

data DirectoryLayer Source #

Represents a directory tree. A value of this type must be supplied to all functions in this module.

Constructors

DirectoryLayer
Fields nodeSS :: Subspace Subspace for directory metadata. contentSS :: Subspace Subspace for directory content. allocator :: HCA rootNode :: Subspace allowManualPrefixes :: Bool dlPath :: [Text]

Instances

Instances details

Eq DirectoryLayer Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods (==) :: DirectoryLayer -> DirectoryLayer -> Bool # (/=) :: DirectoryLayer -> DirectoryLayer -> Bool #
Ord DirectoryLayer Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods compare :: DirectoryLayer -> DirectoryLayer -> Ordering # (<) :: DirectoryLayer -> DirectoryLayer -> Bool # (<=) :: DirectoryLayer -> DirectoryLayer -> Bool # (>) :: DirectoryLayer -> DirectoryLayer -> Bool # (>=) :: DirectoryLayer -> DirectoryLayer -> Bool # max :: DirectoryLayer -> DirectoryLayer -> DirectoryLayer # min :: DirectoryLayer -> DirectoryLayer -> DirectoryLayer #
Show DirectoryLayer Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods showsPrec :: Int -> DirectoryLayer -> ShowS # show :: DirectoryLayer -> String # showList :: [DirectoryLayer] -> ShowS #

type Path = [Text] Source #

A path is a list of unicode strings.

data Directory Source #

Represents a single directory.

Constructors

Directory
Fields directorySubspace :: Subspace directoryPath :: Path directoryLayer :: ByteString

Instances

Instances details

Eq Directory Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods (==) :: Directory -> Directory -> Bool # (/=) :: Directory -> Directory -> Bool #
Ord Directory Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods compare :: Directory -> Directory -> Ordering # (<) :: Directory -> Directory -> Bool # (<=) :: Directory -> Directory -> Bool # (>) :: Directory -> Directory -> Bool # (>=) :: Directory -> Directory -> Bool # max :: Directory -> Directory -> Directory # min :: Directory -> Directory -> Directory #
Show Directory Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods showsPrec :: Int -> Directory -> ShowS # show :: Directory -> String # showList :: [Directory] -> ShowS #

dirSubspace :: Directory -> Subspace Source #

Gets the content subspace of a directory, which can be used to store tuple-based keys.

dirPath :: Directory -> Path Source #

Gets the path of a directory.

dirLayer :: Directory -> ByteString Source #

Gets the layer tag that was specified when the directory was created.

data DirPartition Source #

Constructors

DirPartition
Fields dirPartition :: DirectoryLayer dirPartitionParentDL :: DirectoryLayer

Instances

Instances details

Eq DirPartition Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods (==) :: DirPartition -> DirPartition -> Bool # (/=) :: DirPartition -> DirPartition -> Bool #
Ord DirPartition Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods compare :: DirPartition -> DirPartition -> Ordering # (<) :: DirPartition -> DirPartition -> Bool # (<=) :: DirPartition -> DirPartition -> Bool # (>) :: DirPartition -> DirPartition -> Bool # (>=) :: DirPartition -> DirPartition -> Bool # max :: DirPartition -> DirPartition -> DirPartition # min :: DirPartition -> DirPartition -> DirPartition #
Show DirPartition Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods showsPrec :: Int -> DirPartition -> ShowS # show :: DirPartition -> String # showList :: [DirPartition] -> ShowS #

newDirectoryLayer Source #

Arguments

:: Subspace	node subspace for directory metadata
-> Subspace	content subspace
-> Bool	allow manual prefixes
-> DirectoryLayer

Creates a new directory layer, containing a hierarchy of directories.

defaultDirLayer :: DirectoryLayer Source #

The default directory layer has node subspace prefix 0xfe. This corresponds to using the defaults for all arguments to the DirectoryLayer constructor in other languages' bindings.

open :: DirectoryLayer -> Path -> Transaction (Maybe Directory) Source #

Tries to open a directory at the given path. If the directory exists, returns it. Otherwise, returns Nothing.

createOrOpen :: DirectoryLayer -> Path -> Transaction Directory Source #

Opens a directory at the given path. If the directory does not exist, it is created.

open' Source #

Arguments

:: DirectoryLayer
-> Path
-> ByteString	layer
-> Maybe ByteString	optional custom prefix
-> Transaction (Maybe Directory)

Open a directory, with optional custom prefix and layer. Returns Nothing if the directory doesn't exist.

createOrOpen' Source #

Arguments

:: DirectoryLayer
-> Path
-> ByteString	layer
-> Maybe ByteString	optional custom prefix
-> Transaction Directory

Opens a directory at the given path, with optional custom prefix and layer.

exists :: DirectoryLayer -> Path -> Transaction Bool Source #

Returns True iff the given path exists.

list :: DirectoryLayer -> Path -> Transaction (Seq Text) Source #

List the names of the immediate subdirectories of a directory. Returns an empty list if the directory does not exist.

data MoveError Source #

Represents all ways move may fail.

Constructors

SelfSubDir	returned by `move` if you attempt to move a directory into a subdirectory of itself.
SourceDoesNotExist	Returned by `move` if the source subdirectory does not exist.
MoveBetweenPartitions	Returned by `move` if you attempt to move a directory from one partition to another.
DestinationAlreadyExists	Returned by `move` if the destination directory already exists.
DestinationParentDoesNotExist	Returned by `move` if the parent of the destination directory doesn't already exist.
CannotMoveToRoot	Returned by `move` if the destination path is the root path.

Instances

Instances details

Eq MoveError Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods (==) :: MoveError -> MoveError -> Bool # (/=) :: MoveError -> MoveError -> Bool #
Ord MoveError Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods compare :: MoveError -> MoveError -> Ordering # (<) :: MoveError -> MoveError -> Bool # (<=) :: MoveError -> MoveError -> Bool # (>) :: MoveError -> MoveError -> Bool # (>=) :: MoveError -> MoveError -> Bool # max :: MoveError -> MoveError -> MoveError # min :: MoveError -> MoveError -> MoveError #
Show MoveError Source #
Instance details Defined in FoundationDB.Layer.Directory.Internal Methods showsPrec :: Int -> MoveError -> ShowS # show :: MoveError -> String # showList :: [MoveError] -> ShowS #

move Source #

Arguments

:: DirectoryLayer
-> Path	from path
-> Path	to path
-> Transaction (Maybe MoveError)

Move a directory from one path to another. Returns Just err if an error occurred. If an error is returned, the directory structure is left unchanged.

remove :: DirectoryLayer -> Path -> Transaction Bool Source #

Remove a directory path, its contents, and all subdirectories. Returns True if removal succeeds. Fails for nonexistent paths and the root directory. In cases of failure, the directory structure is unchanged.

removeRecursive Source #

Arguments

:: DirectoryLayer
-> Subspace	node
-> Transaction ()

Internal helper function that removes all subdirectories of the given node subspace. Does not remove the given node from its parent.

removeFromParent :: DirectoryLayer -> Path -> Transaction () Source #

Internal helper function that removes a path from its parent. Does not remove the children of the removed path.

subdirNameNodes Source #

Arguments

:: DirectoryLayer
-> Subspace	node
-> Transaction (Seq (Text, Subspace))

subdirNames :: DirectoryLayer -> Subspace -> Transaction (Seq Text) Source #

subdirNodes :: DirectoryLayer -> Subspace -> Transaction (Seq Subspace) Source #

nodeContainingKey :: DirectoryLayer -> ByteString -> Transaction (Maybe Subspace) Source #

isPrefixFree :: DirectoryLayer -> ByteString -> Transaction Bool Source #

checkVersion :: DirectoryLayer -> Transaction () Source #

initializeDirectory :: DirectoryLayer -> Transaction () Source #

nodeWithPrefix :: DirectoryLayer -> ByteString -> Subspace Source #

find :: DirectoryLayer -> Path -> Transaction (Maybe FoundNode) Source #

Returns the longest prefix of path that doesn't exist. If the entire path exists, returns it.

contentsOfNodePartition Source #

Arguments

:: DirectoryLayer
-> Subspace	node
-> Path
-> Transaction DirPartition

contentsOfNodeSubspace :: DirectoryLayer -> Subspace -> Path -> ByteString -> Transaction Directory Source #