gitlib-libgit2-3.1.2: Libgit2 backend for gitlib

Safe HaskellNone
LanguageHaskell98

Git.Libgit2

Contents

Description

Interface for opening and creating repositories. Repository objects are immutable, and serve only to refer to the given repository. Any data associated with the repository — such as the list of branches — is queried as needed.

Documentation

type MonadLg m = (Applicative m, MonadExcept m, MonadUnliftIO m) Source #

class HasLgRepo m where Source #

Minimal complete definition

getRepository

Methods

getRepository :: m LgRepo Source #

Instances
Monad m => HasLgRepo (ReaderT LgRepo m) Source # 
Instance details

Defined in Git.Libgit2

Methods

getRepository :: ReaderT LgRepo m LgRepo Source #

data LgRepo Source #

Constructors

LgRepo 

Fields

Instances
(Applicative m, MonadExcept m, MonadUnliftIO m, HasLgRepo m) => MonadGit LgRepo m # 
Instance details

Defined in Git.Libgit2

Associated Types

type Oid LgRepo :: * #

data Tree LgRepo :: * #

data Options LgRepo :: * #

Methods

facts :: m RepositoryFacts #

parseOid :: Text -> m (Oid LgRepo) #

getRepository :: m LgRepo #

closeRepository :: m () #

deleteRepository :: m () #

createReference :: RefName -> RefTarget LgRepo -> m () #

lookupReference :: RefName -> m (Maybe (RefTarget LgRepo)) #

updateReference :: RefName -> RefTarget LgRepo -> m () #

deleteReference :: RefName -> m () #

sourceReferences :: ConduitT i RefName m () #

lookupObject :: Oid LgRepo -> m (Object LgRepo m) #

existsObject :: Oid LgRepo -> m Bool #

sourceObjects :: Maybe (CommitOid LgRepo) -> CommitOid LgRepo -> Bool -> ConduitT i (ObjectOid LgRepo) m () #

lookupCommit :: CommitOid LgRepo -> m (Commit LgRepo) #

lookupTree :: TreeOid LgRepo -> m (Tree LgRepo) #

lookupBlob :: BlobOid LgRepo -> m (Blob LgRepo m) #

lookupTag :: TagOid LgRepo -> m (Tag LgRepo) #

readIndex :: TreeT LgRepo m () #

writeIndex :: TreeT LgRepo m () #

newTreeBuilder :: Maybe (Tree LgRepo) -> m (TreeBuilder LgRepo m) #

treeOid :: Tree LgRepo -> m (TreeOid LgRepo) #

treeEntry :: Tree LgRepo -> TreeFilePath -> m (Maybe (TreeEntry LgRepo)) #

sourceTreeEntries :: Tree LgRepo -> ConduitT i (TreeFilePath, TreeEntry LgRepo) m () #

diffContentsWithTree :: ConduitT () (Either TreeFilePath ByteString) m () -> Tree LgRepo -> ConduitT i ByteString m () #

hashContents :: BlobContents m -> m (BlobOid LgRepo) #

createBlob :: BlobContents m -> m (BlobOid LgRepo) #

createCommit :: [CommitOid LgRepo] -> TreeOid LgRepo -> Signature -> Signature -> CommitMessage -> Maybe RefName -> m (Commit LgRepo) #

createTag :: CommitOid LgRepo -> Signature -> CommitMessage -> Text -> m (Tag LgRepo) #

Monad m => HasLgRepo (ReaderT LgRepo m) Source # 
Instance details

Defined in Git.Libgit2

Methods

getRepository :: ReaderT LgRepo m LgRepo Source #

data Options LgRepo # 
Instance details

Defined in Git.Libgit2

data Options LgRepo = Options
data Tree LgRepo # 
Instance details

Defined in Git.Libgit2

data Tree LgRepo = LgTree {}
type Oid LgRepo # 
Instance details

Defined in Git.Libgit2

type Oid LgRepo = OidPtr

type BlobOid = BlobOid LgRepo Source #

type Commit = Commit LgRepo Source #

type CommitOid = CommitOid LgRepo Source #

type family Oid r :: * #

Instances
type Oid LgRepo # 
Instance details

Defined in Git.Libgit2

type Oid LgRepo = OidPtr

data OidPtr Source #

Constructors

OidPtr 

Fields

Instances
Eq OidPtr Source # 
Instance details

Defined in Git.Libgit2

Methods

(==) :: OidPtr -> OidPtr -> Bool #

(/=) :: OidPtr -> OidPtr -> Bool #

Ord OidPtr Source # 
Instance details

Defined in Git.Libgit2

Methods

compare :: OidPtr -> OidPtr -> Ordering #

(<) :: OidPtr -> OidPtr -> Bool #

(<=) :: OidPtr -> OidPtr -> Bool #

(>) :: OidPtr -> OidPtr -> Bool #

(>=) :: OidPtr -> OidPtr -> Bool #

max :: OidPtr -> OidPtr -> OidPtr #

min :: OidPtr -> OidPtr -> OidPtr #

Show OidPtr Source # 
Instance details

Defined in Git.Libgit2

Methods

showsPrec :: Int -> OidPtr -> ShowS #

show :: OidPtr -> String #

showList :: [OidPtr] -> ShowS #

IsOid OidPtr Source # 
Instance details

Defined in Git.Libgit2

Methods

renderOid :: OidPtr -> Text #

renderObjOid :: Tagged a OidPtr -> Text #

mkOid :: ForeignPtr C'git_oid -> OidPtr Source #

type Tree = Tree LgRepo Source #

type TreeOid = TreeOid LgRepo Source #

lgRepoPath :: LgRepo -> FilePath Source #

addTracingBackend :: LgRepo -> IO () Source #

checkResult :: (Eq a, Num a, MonadExcept m) => a -> Text -> m () Source #

lgBuildPackIndex :: MonadUnliftIO m => FilePath -> ByteString -> m (Text, FilePath, FilePath) Source #

lgFactory :: (MonadIO m, MonadMask m) => RepositoryFactory (ReaderT LgRepo m) m LgRepo Source #

lgForEachObject :: Ptr C'git_odb -> (Ptr C'git_oid -> Ptr () -> IO CInt) -> Ptr () -> IO CInt Source #

lgExcTrap :: (MonadLg m, HasLgRepo m) => m (IORef (Maybe GitException)) Source #

lgBuildPackFile :: MonadLg m => FilePath -> [Either CommitOid TreeOid] -> ReaderT LgRepo m FilePath Source #

lgReadFromPack :: (MonadIO m, MonadExcept m) => Ptr C'git_odb -> SHA -> Bool -> m (Maybe (C'git_otype, CSize, ByteString)) Source #

lgOpenPackFile :: (MonadExcept m, MonadUnliftIO m) => FilePath -> m (Ptr C'git_odb) Source #

lgClosePackFile :: (MonadIO m, MonadExcept m) => Ptr C'git_odb -> m () Source #

lgWithPackFile :: (MonadExcept m, MonadUnliftIO m) => FilePath -> (Ptr C'git_odb -> m a) -> m a Source #

lgCopyPackFile :: MonadLg m => FilePath -> ReaderT LgRepo m () Source #

lgDiffContentsWithTree :: MonadLg m => Source (ReaderT LgRepo m) (Either TreeFilePath (Either SHA ByteString)) -> Tree -> Producer (ReaderT LgRepo m) ByteString Source #

lgWrap :: (MonadLg m, HasLgRepo m) => m a -> m a Source #

oidToSha :: Ptr C'git_oid -> IO SHA Source #

shaToCOid :: SHA -> IO (ForeignPtr C'git_oid) Source #

shaToOid :: SHA -> IO OidPtr Source #

openLgRepository :: (MonadIO m, MonadMask m) => RepositoryOptions -> m LgRepo Source #

runLgRepository :: LgRepo -> ReaderT LgRepo m a -> m a Source #

lgDebug :: MonadIO m => String -> m () Source #

lgWarn :: MonadIO m => String -> m () Source #

Orphan instances

(Applicative m, MonadExcept m, MonadUnliftIO m, HasLgRepo m) => MonadGit LgRepo m Source # 
Instance details

Associated Types

type Oid LgRepo :: * #

data Tree LgRepo :: * #

data Options LgRepo :: * #

Methods

facts :: m RepositoryFacts #

parseOid :: Text -> m (Oid LgRepo) #

getRepository :: m LgRepo #

closeRepository :: m () #

deleteRepository :: m () #

createReference :: RefName -> RefTarget LgRepo -> m () #

lookupReference :: RefName -> m (Maybe (RefTarget LgRepo)) #

updateReference :: RefName -> RefTarget LgRepo -> m () #

deleteReference :: RefName -> m () #

sourceReferences :: ConduitT i RefName m () #

lookupObject :: Oid LgRepo -> m (Object LgRepo m) #

existsObject :: Oid LgRepo -> m Bool #

sourceObjects :: Maybe (CommitOid LgRepo) -> CommitOid LgRepo -> Bool -> ConduitT i (ObjectOid LgRepo) m () #

lookupCommit :: CommitOid LgRepo -> m (Commit LgRepo) #

lookupTree :: TreeOid LgRepo -> m (Tree LgRepo) #

lookupBlob :: BlobOid LgRepo -> m (Blob LgRepo m) #

lookupTag :: TagOid LgRepo -> m (Tag LgRepo) #

readIndex :: TreeT LgRepo m () #

writeIndex :: TreeT LgRepo m () #

newTreeBuilder :: Maybe (Tree LgRepo) -> m (TreeBuilder LgRepo m) #

treeOid :: Tree LgRepo -> m (TreeOid LgRepo) #

treeEntry :: Tree LgRepo -> TreeFilePath -> m (Maybe (TreeEntry LgRepo)) #

sourceTreeEntries :: Tree LgRepo -> ConduitT i (TreeFilePath, TreeEntry LgRepo) m () #

diffContentsWithTree :: ConduitT () (Either TreeFilePath ByteString) m () -> Tree LgRepo -> ConduitT i ByteString m () #

hashContents :: BlobContents m -> m (BlobOid LgRepo) #

createBlob :: BlobContents m -> m (BlobOid LgRepo) #

createCommit :: [CommitOid LgRepo] -> TreeOid LgRepo -> Signature -> Signature -> CommitMessage -> Maybe RefName -> m (Commit LgRepo) #

createTag :: CommitOid LgRepo -> Signature -> CommitMessage -> Text -> m (Tag LgRepo) #