git-annex/Types/Key.hs

{- git-annex Key data type
 -
 - Copyright 2011-2017 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

module Types.Key where

import System.Posix.Types

{- A Key has a unique name, which is derived from a particular backend,
 - and may contain other optional metadata. -}
data Key = Key
	{ keyName :: String
	, keyBackendName :: String
	, keySize :: Maybe Integer
	, keyMtime :: Maybe EpochTime
	, keyChunkSize :: Maybe Integer
	, keyChunkNum :: Maybe Integer
	} deriving (Eq, Ord, Read, Show)

{- A filename may be associated with a Key. -}
type AssociatedFile = Maybe FilePath
a new Key data type with metadata 2011-03-15 21:47:29 +00:00			`{- git-annex Key data type`
			`-`
make file2key reject E* backend keys with a long extension I am not happy that I had to put backend-specific code in file2key. But it would be very difficult to avoid this layering violation. Most of the time, when parsing a Key from a symlink target, git-annex never looks up its Backend at all, so adding this check to a method of the Backend object would not work. The Key could be made to contain the appropriate Backend, but since Backend is parameterized on an "a" that is fixed to the Annex monad later, that would need Key to change to "Key a". The only way to clean this up that I can see would be to have the Key contain a LowlevelBackend, and put the validation in LowlevelBackend. Perhaps later, but that would be an extensive change, so let's not do it in this commit which may want to cherry-pick to backports. This commit was sponsored by Ethan Aubin. 2017-02-24 15:17:07 +00:00			`- Copyright 2011-2017 Joey Hess <id@joeyh.name>`
a new Key data type with metadata 2011-03-15 21:47:29 +00:00			`-`
			`- Licensed under the GNU GPL version 3 or higher.`
			`-}`

factor non-type stuff out of Key 2017-02-24 17:42:30 +00:00			`module Types.Key where`
a new Key data type with metadata 2011-03-15 21:47:29 +00:00
first pass at using new keys It compiles. It sorta works. Several subcommands are FIXME marked and broken, because things that used to accept separate --backend and --key params need to be changed to accept just a --key that encodes all the key info, now that there is metadata in keys. 2011-03-16 01:34:13 +00:00			`import System.Posix.Types`
factor out common imports no code changes 2011-10-04 02:24:57 +00:00
moved AssociatedFile definition 2013-07-04 06:36:02 +00:00			`{- A Key has a unique name, which is derived from a particular backend,`
first pass at using new keys It compiles. It sorta works. Several subcommands are FIXME marked and broken, because things that used to accept separate --backend and --key params need to be changed to accept just a --key that encodes all the key info, now that there is metadata in keys. 2011-03-16 01:34:13 +00:00			`- and may contain other optional metadata. -}`
layout 2013-07-04 06:45:46 +00:00			`data Key = Key`
			`{ keyName :: String`
			`, keyBackendName :: String`
			`, keySize :: Maybe Integer`
			`, keyMtime :: Maybe EpochTime`
add chunk metadata to Key Added new fields for chunk number, and chunk size. These will not appear in normal keys ever, but will be used for chunked data stored on special remotes. This commit was sponsored by Jouni K Seppanen. 2014-07-24 17:36:23 +00:00			`, keyChunkSize :: Maybe Integer`
			`, keyChunkNum :: Maybe Integer`
layout 2013-07-04 06:45:46 +00:00			`} deriving (Eq, Ord, Read, Show)`
a new Key data type with metadata 2011-03-15 21:47:29 +00:00
moved AssociatedFile definition 2013-07-04 06:36:02 +00:00			`{- A filename may be associated with a Key. -}`
			`type AssociatedFile = Maybe FilePath`