| Safe Haskell | None |
|---|
Git.Types
- data RepositoryFacts = RepositoryFacts {}
- type MonadGit m = (Failure GitException m, Applicative m, MonadIO m, MonadBaseControl IO m)
- type RefName = Text
- type CommitAuthor = Text
- type CommitEmail = Text
- type CommitMessage = Text
- type TreeFilePath = RawFilePath
- class (Applicative m, Monad m, Failure GitException m, IsOid (Oid m)) => Repository m where
- type Oid m :: *
- data Tree m :: *
- data Options m :: *
- facts :: m RepositoryFacts
- parseOid :: Text -> m (Oid m)
- deleteRepository :: m ()
- createReference :: RefName -> RefTarget m -> m ()
- lookupReference :: RefName -> m (Maybe (RefTarget m))
- updateReference :: RefName -> RefTarget m -> m ()
- deleteReference :: RefName -> m ()
- listReferences :: m [RefName]
- lookupCommit :: CommitOid m -> m (Commit m)
- lookupTree :: TreeOid m -> m (Tree m)
- lookupBlob :: BlobOid m -> m (Blob m)
- lookupTag :: TagOid m -> m (Tag m)
- lookupObject :: Oid m -> m (Object m)
- existsObject :: Oid m -> m Bool
- sourceObjects :: Maybe (CommitOid m) -> CommitOid m -> Bool -> Source m (ObjectOid m)
- newTreeBuilder :: Maybe (Tree m) -> m (TreeBuilder m)
- treeOid :: Tree m -> TreeOid m
- treeEntry :: Tree m -> TreeFilePath -> m (Maybe (TreeEntry m))
- listTreeEntries :: Tree m -> m [(TreeFilePath, TreeEntry m)]
- hashContents :: BlobContents m -> m (BlobOid m)
- createBlob :: BlobContents m -> m (BlobOid m)
- createCommit :: [CommitOid m] -> TreeOid m -> Signature -> Signature -> CommitMessage -> Maybe RefName -> m (Commit m)
- createTag :: CommitOid m -> Signature -> CommitMessage -> Text -> m (Tag m)
- data RepositoryOptions = RepositoryOptions {
- repoPath :: !FilePath
- repoIsBare :: !Bool
- repoAutoCreate :: !Bool
- data RepositoryFactory t m c = RepositoryFactory {
- openRepository :: RepositoryOptions -> m c
- runRepository :: forall a. c -> t m a -> m a
- closeRepository :: c -> m ()
- getRepository :: t m c
- defaultOptions :: !RepositoryOptions
- startupBackend :: m ()
- shutdownBackend :: m ()
- class (Eq o, Ord o, Show o) => IsOid o where
- renderOid :: o -> Text
- renderObjOid :: Tagged a o -> Text
- type BlobOid m = Tagged (Blob m) (Oid m)
- type TreeOid m = Tagged (Tree m) (Oid m)
- type CommitOid m = Tagged (Commit m) (Oid m)
- type TagOid m = Tagged (Tag m) (Oid m)
- data ObjectOid m
- = BlobObjOid !(BlobOid m)
- | TreeObjOid !(TreeOid m)
- | CommitObjOid !(CommitOid m)
- | TagObjOid !(TagOid m)
- parseObjOid :: Repository m => forall o. Text -> m (Tagged o (Oid m))
- copyOid :: (Repository m, Repository n) => Oid m -> n (Oid n)
- newtype SHA = SHA ByteString
- shaToText :: SHA -> Text
- textToSha :: Monad m => Text -> m SHA
- data Blob m = Blob {
- blobOid :: !(BlobOid m)
- blobContents :: !(BlobContents m)
- type ByteSource m = Producer m ByteString
- data BlobContents m
- = BlobString !ByteString
- | BlobStream !(ByteSource m)
- | BlobSizedStream !(ByteSource m) !Int
- data BlobKind
- data TreeEntry m
- = BlobEntry {
- blobEntryOid :: !(BlobOid m)
- blobEntryKind :: !BlobKind
- | TreeEntry {
- treeEntryOid :: !(TreeOid m)
- | CommitEntry {
- commitEntryOid :: !(CommitOid m)
- = BlobEntry {
- treeEntryToOid :: Repository m => TreeEntry m -> Oid m
- data TreeBuilder m = TreeBuilder {
- mtbBaseTreeOid :: Maybe (TreeOid m)
- mtbPendingUpdates :: HashMap TreeFilePath (TreeBuilder m)
- mtbNewBuilder :: Maybe (Tree m) -> m (TreeBuilder m)
- mtbWriteContents :: TreeBuilder m -> m (ModifiedBuilder m, TreeOid m)
- mtbLookupEntry :: TreeFilePath -> m (Maybe (TreeEntry m))
- mtbEntryCount :: m Int
- mtbPutEntry :: TreeBuilder m -> TreeFilePath -> TreeEntry m -> m (ModifiedBuilder m)
- mtbDropEntry :: TreeBuilder m -> TreeFilePath -> m (ModifiedBuilder m)
- data ModifiedBuilder m
- = ModifiedBuilder (TreeBuilder m)
- | BuilderUnchanged (TreeBuilder m)
- fromBuilderMod :: ModifiedBuilder m -> TreeBuilder m
- data Commit m = Commit {
- commitOid :: !(CommitOid m)
- commitParents :: ![CommitOid m]
- commitTree :: !(TreeOid m)
- commitAuthor :: !Signature
- commitCommitter :: !Signature
- commitLog :: !CommitMessage
- commitEncoding :: !Text
- lookupCommitParents :: Repository m => Commit m -> m [Commit m]
- data Signature = Signature {}
- data Tag m = Tag {}
- data Object m
- objectOid :: Repository m => Object m -> Oid m
- loadObject :: Repository m => ObjectOid m -> m (Object m)
- objectToObjOid :: Repository m => Object m -> ObjectOid m
- untagObjOid :: Repository m => ObjectOid m -> Oid m
- data RefTarget m
- = RefObj !(CommitOid m)
- | RefSymbolic !RefName
- commitRefTarget :: Commit m -> RefTarget m
- data ModificationKind
- = Unchanged
- | Modified
- | Added
- | Deleted
- | TypeChanged
- data MergeStatus
- mergeStatus :: ModificationKind -> ModificationKind -> MergeStatus
- data MergeResult m
- = MergeSuccess {
- mergeCommit :: CommitOid m
- | MergeConflicted { }
- = MergeSuccess {
- copyMergeResult :: (Repository m, MonadGit m, Repository n, MonadGit n) => MergeResult m -> n (MergeResult n)
- data GitException
- = BackendError Text
- | GitError Text
- | RepositoryNotExist
- | RepositoryInvalid
- | RepositoryCannotAccess Text
- | BlobCreateFailed
- | BlobEmptyCreateFailed
- | BlobEncodingUnknown Text
- | BlobLookupFailed
- | PushNotFastForward Text
- | TranslationException Text
- | TreeCreateFailed Text
- | TreeBuilderCreateFailed
- | TreeBuilderInsertFailed TreeFilePath
- | TreeBuilderRemoveFailed TreeFilePath
- | TreeBuilderWriteFailed Text
- | TreeLookupFailed
- | TreeCannotTraverseBlob
- | TreeCannotTraverseCommit
- | TreeEntryLookupFailed TreeFilePath
- | TreeUpdateFailed
- | TreeWalkFailed
- | TreeEmptyCreateFailed
- | CommitCreateFailed
- | CommitLookupFailed Text
- | ReferenceCreateFailed RefName
- | ReferenceDeleteFailed RefName
- | RefCannotCreateFromPartialOid
- | ReferenceListingFailed
- | ReferenceLookupFailed RefName
- | ObjectLookupFailed Text Int
- | ObjectRefRequiresFullOid
- | OidCopyFailed
- | OidParseFailed Text
- | QuotaHardLimitExceeded Int Int
Documentation
type MonadGit m = (Failure GitException m, Applicative m, MonadIO m, MonadBaseControl IO m)Source
type CommitAuthor = TextSource
type CommitEmail = TextSource
type CommitMessage = TextSource
type TreeFilePath = RawFilePathSource
class (Applicative m, Monad m, Failure GitException m, IsOid (Oid m)) => Repository m whereSource
Repository is the central point of contact between user code and Git
data objects. Every object must belong to some repository.
Methods
facts :: m RepositoryFactsSource
parseOid :: Text -> m (Oid m)Source
deleteRepository :: m ()Source
createReference :: RefName -> RefTarget m -> m ()Source
lookupReference :: RefName -> m (Maybe (RefTarget m))Source
updateReference :: RefName -> RefTarget m -> m ()Source
deleteReference :: RefName -> m ()Source
listReferences :: m [RefName]Source
lookupCommit :: CommitOid m -> m (Commit m)Source
lookupTree :: TreeOid m -> m (Tree m)Source
lookupBlob :: BlobOid m -> m (Blob m)Source
lookupTag :: TagOid m -> m (Tag m)Source
lookupObject :: Oid m -> m (Object m)Source
existsObject :: Oid m -> m BoolSource
Arguments
| :: Maybe (CommitOid m) | A commit we may already have |
| -> CommitOid m | The commit we need |
| -> Bool | Include commit trees also? |
| -> Source m (ObjectOid m) | All the objects in between |
newTreeBuilder :: Maybe (Tree m) -> m (TreeBuilder m)Source
treeOid :: Tree m -> TreeOid mSource
treeEntry :: Tree m -> TreeFilePath -> m (Maybe (TreeEntry m))Source
listTreeEntries :: Tree m -> m [(TreeFilePath, TreeEntry m)]Source
hashContents :: BlobContents m -> m (BlobOid m)Source
createBlob :: BlobContents m -> m (BlobOid m)Source
createCommit :: [CommitOid m] -> TreeOid m -> Signature -> Signature -> CommitMessage -> Maybe RefName -> m (Commit m)Source
createTag :: CommitOid m -> Signature -> CommitMessage -> Text -> m (Tag m)Source
data RepositoryOptions Source
Constructors
| RepositoryOptions | |
Fields
| |
Instances
data RepositoryFactory t m c Source
Constructors
| RepositoryFactory | |
Fields
| |
Constructors
| BlobObjOid !(BlobOid m) | |
| TreeObjOid !(TreeOid m) | |
| CommitObjOid !(CommitOid m) | |
| TagObjOid !(TagOid m) |
parseObjOid :: Repository m => forall o. Text -> m (Tagged o (Oid m))Source
copyOid :: (Repository m, Repository n) => Oid m -> n (Oid n)Source
Constructors
| SHA ByteString |
Constructors
| Blob | |
Fields
| |
type ByteSource m = Producer m ByteStringSource
data BlobContents m Source
Constructors
| BlobString !ByteString | |
| BlobStream !(ByteSource m) | |
| BlobSizedStream !(ByteSource m) !Int |
Instances
| Eq (BlobContents m) |
Constructors
| PlainBlob | |
| ExecutableBlob | |
| SymlinkBlob | |
| UnknownBlob |
Constructors
| BlobEntry | |
Fields
| |
| TreeEntry | |
Fields
| |
| CommitEntry | |
Fields
| |
Instances
| Repository m => Show (TreeEntry m) |
treeEntryToOid :: Repository m => TreeEntry m -> Oid mSource
data TreeBuilder m Source
Constructors
| TreeBuilder | |
Fields
| |
data ModifiedBuilder m Source
Constructors
| ModifiedBuilder (TreeBuilder m) | |
| BuilderUnchanged (TreeBuilder m) |
Instances
fromBuilderMod :: ModifiedBuilder m -> TreeBuilder mSource
Constructors
| Commit | |
Fields
| |
lookupCommitParents :: Repository m => Commit m -> m [Commit m]Source
Constructors
| Signature | |
Fields | |
objectOid :: Repository m => Object m -> Oid mSource
loadObject :: Repository m => ObjectOid m -> m (Object m)Source
objectToObjOid :: Repository m => Object m -> ObjectOid mSource
untagObjOid :: Repository m => ObjectOid m -> Oid mSource
Constructors
| RefObj !(CommitOid m) | |
| RefSymbolic !RefName |
Instances
| Repository m => Show (RefTarget m) |
commitRefTarget :: Commit m -> RefTarget mSource
data ModificationKind Source
Constructors
| Unchanged | |
| Modified | |
| Added | |
| Deleted | |
| TypeChanged |
data MergeStatus Source
Constructors
Instances
data MergeResult m Source
Constructors
| MergeSuccess | |
Fields
| |
| MergeConflicted | |
Fields | |
Instances
| Repository m => Show (MergeResult m) |
copyMergeResult :: (Repository m, MonadGit m, Repository n, MonadGit n) => MergeResult m -> n (MergeResult n)Source
data GitException Source
There is a separate GitException for each possible failure when
interacting with the Git repository.
Constructors