aboutsummaryrefslogtreecommitdiff
path: root/Types/Backend.hs
blob: f1d8919a494837b92bbe92ac4e6f83d5f5e1edfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{- git-annex key backend data type
 -
 - Most things should not need this, using Types instead
 -
 - Copyright 2010-2017 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

module Types.Backend where

import Types.Key
import Types.KeySource

data BackendA a = Backend
	{ backendVariety :: KeyVariety
	, getKey :: KeySource -> a (Maybe Key) 
	-- Verifies the content of a key.
	, verifyKeyContent :: Maybe (Key -> FilePath -> a Bool)
	-- Checks if a key can be upgraded to a better form.
	, canUpgradeKey :: Maybe (Key -> Bool)
	-- Checks if there is a fast way to migrate a key to a different
	-- backend (ie, without re-hashing).
	, fastMigrate :: Maybe (Key -> BackendA a -> AssociatedFile -> Maybe Key)
	-- Checks if a key is known (or assumed) to always refer to the
	-- same data.
	, isStableKey :: Key -> Bool
	}

instance Show (BackendA a) where
	show backend = "Backend { name =\"" ++ formatKeyVariety (backendVariety backend) ++ "\" }"

instance Eq (BackendA a) where
	a == b = backendVariety a == backendVariety b