hackage-security-0.5.2.2: Hackage security library

Safe Haskell | None
Language | Haskell2010

Hackage.Security.TUF.FileMap

Contents

- Standard accessors
- Convenience accessors
- Comparing file maps

Description

Information about files

Intended to be double imported

    import Hackage.Security.TUF.FileMap (FileMap)
    import qualified Hackage.Security.TUF.FileMap as FileMap

Synopsis

- data FileMap
- data TargetPath
  - = TargetPathRepo RepoPath
  - | TargetPathIndex IndexPath
- empty :: FileMap
- lookup :: TargetPath -> FileMap -> Maybe FileInfo
- (!) :: FileMap -> TargetPath -> FileInfo
- insert :: TargetPath -> FileInfo -> FileMap -> FileMap
- fromList :: [(TargetPath, FileInfo)] -> FileMap
- lookupM :: Monad m => FileMap -> TargetPath -> m FileInfo
- data FileChange
  - = FileChanged FileInfo
  - | FileDeleted
- fileMapChanges :: FileMap -> FileMap -> Map TargetPath FileChange

# Documentation

data FileMap #

Mapping from paths to file info

File maps are used in target files; the paths are relative to the location of the target files containing the file map.

Instances

Show FileMap # |
Methods showsPrec :: Int -> FileMap -> ShowS # show :: FileMap -> String # showList :: [FileMap] -> ShowS #
ReportSchemaErrors m => FromJSON m FileMap # |
Methods fromJSON :: JSValue -> m FileMap #
Monad m => ToJSON m FileMap # |
Methods toJSON :: FileMap -> m JSValue #

data TargetPath #

Entries in `FileMap` either talk about the repository or the index

Constructors

TargetPathRepo RepoPath |
TargetPathIndex IndexPath |

Instances

Eq TargetPath # |
Methods (==) :: TargetPath -> TargetPath -> Bool # (/=) :: TargetPath -> TargetPath -> Bool #
Ord TargetPath # |
Methods compare :: TargetPath -> TargetPath -> Ordering # (<) :: TargetPath -> TargetPath -> Bool # (<=) :: TargetPath -> TargetPath -> Bool # (>) :: TargetPath -> TargetPath -> Bool # (>=) :: TargetPath -> TargetPath -> Bool # max :: TargetPath -> TargetPath -> TargetPath # min :: TargetPath -> TargetPath -> TargetPath #
Show TargetPath # |
Methods showsPrec :: Int -> TargetPath -> ShowS # show :: TargetPath -> String # showList :: [TargetPath] -> ShowS #
Pretty TargetPath # |
Methods pretty :: TargetPath -> String #
ReportSchemaErrors m => FromObjectKey m TargetPath # |
Methods fromObjectKey :: String -> m (Maybe TargetPath) #
Monad m => ToObjectKey m TargetPath # |
Methods toObjectKey :: TargetPath -> m String #

# Standard accessors

empty :: FileMap #

lookup :: TargetPath -> FileMap -> Maybe FileInfo #

(!) :: FileMap -> TargetPath -> FileInfo #

insert :: TargetPath -> FileInfo -> FileMap -> FileMap #

fromList :: [(TargetPath, FileInfo)] -> FileMap #

# Convenience accessors

lookupM :: Monad m => FileMap -> TargetPath -> m FileInfo #

# Comparing file maps

data FileChange #

Constructors

FileChanged FileInfo | File got added or modified; we record the new file info
FileDeleted | File got deleted

Instances

Show FileChange # |
Methods showsPrec :: Int -> FileChange -> ShowS # show :: FileChange -> String # showList :: [FileChange] -> ShowS #

fileMapChanges #

Arguments

:: FileMap | Old
-> FileMap | New
-> Map TargetPath FileChange |