summaryrefslogtreecommitdiff
path: root/Types/Remote.hs
diff options
context:
space:
mode:
Diffstat (limited to 'Types/Remote.hs')
-rw-r--r--Types/Remote.hs6
1 files changed, 4 insertions, 2 deletions
diff --git a/Types/Remote.hs b/Types/Remote.hs
index 2ddb68dfb..805b98474 100644
--- a/Types/Remote.hs
+++ b/Types/Remote.hs
@@ -56,7 +56,9 @@ data RemoteA a = Remote {
name :: RemoteName,
-- Remotes have a use cost; higher is more expensive
cost :: Cost,
- -- Transfers a key to the remote.
+ -- Transfers a key's contents from disk to the remote.
+ -- The key should not appear to be present on the remote until
+ -- all of its contents have been transferred.
storeKey :: Key -> AssociatedFile -> MeterUpdate -> a Bool,
-- Retrieves a key's contents to a file.
-- (The MeterUpdate does not need to be used if it retrieves
@@ -64,7 +66,7 @@ data RemoteA a = Remote {
retrieveKeyFile :: Key -> AssociatedFile -> FilePath -> MeterUpdate -> a Bool,
-- retrieves a key's contents to a tmp file, if it can be done cheaply
retrieveKeyFileCheap :: Key -> FilePath -> a Bool,
- -- removes a key's contents
+ -- removes a key's contents (succeeds if the contents are not present)
removeKey :: Key -> a Bool,
-- Checks if a key is present in the remote; if the remote
-- cannot be accessed returns a Left error message.