| Copyright | Copyright (C) 2009 John MacFarlane |
|---|---|
| License | BSD 3 |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
| Stability | alpha |
| Portability | GHC 6.10 required |
| Safe Haskell | Safe-Inferred |
| Language | Haskell98 |
Data.FileStore.Types
Description
Type definitions for Data.FileStore.
- type RevisionId = String
- data Resource
- data Author = Author {}
- data Change
- type Description = String
- data Revision = Revision {}
- class Contents a where
- fromByteString :: ByteString -> a
- toByteString :: a -> ByteString
- data TimeRange = TimeRange {}
- data MergeInfo = MergeInfo {}
- data FileStoreError
- data SearchMatch = SearchMatch {}
- data SearchQuery = SearchQuery {}
- defaultSearchQuery :: SearchQuery
- data UTCTime :: *
- data FileStore = FileStore {
- initialize :: IO ()
- save :: Contents a => FilePath -> Author -> Description -> a -> IO ()
- retrieve :: Contents a => FilePath -> Maybe RevisionId -> IO a
- delete :: FilePath -> Author -> Description -> IO ()
- rename :: FilePath -> FilePath -> Author -> Description -> IO ()
- history :: [FilePath] -> TimeRange -> Maybe Int -> IO [Revision]
- latest :: FilePath -> IO RevisionId
- revision :: RevisionId -> IO Revision
- index :: IO [FilePath]
- directory :: FilePath -> IO [Resource]
- idsMatch :: RevisionId -> RevisionId -> Bool
- search :: SearchQuery -> IO [SearchMatch]
Documentation
type RevisionId = String Source
Constructors
| FSFile FilePath | |
| FSDirectory FilePath |
Constructors
| Author | |
Fields
| |
type Description = String Source
Constructors
| Revision | |
Fields
| |
Instances
Constructors
| TimeRange | |
Constructors
| MergeInfo | |
Fields
| |
data FileStoreError Source
Constructors
| RepositoryExists | Tried to initialize a repo that exists |
| ResourceExists | Tried to create a resource that exists |
| NotFound | Requested resource was not found |
| IllegalResourceName | The specified resource name is illegal |
| Unchanged | The resource was not modified, because the contents were unchanged |
| UnsupportedOperation | |
| NoMaxCount | The darcs version used does not support --max-count |
| UnknownError String |
data SearchQuery Source
Constructors
| SearchQuery | |
Fields
| |
Instances
data UTCTime :: *
This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.
A versioning filestore, which can be implemented using the file system, a database, or revision-control software.
Constructors
| FileStore | |
Fields
| |