Git.Libgit2

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)

class HasLgRepo m where

Minimal complete definition

getRepository

Methods

getRepository :: m LgRepo

Instances

Monad m => HasLgRepo (ReaderT LgRepo m)

Defined in Git.Libgit2

Methods

getRepository :: ReaderT LgRepo m LgRepo

data LgRepo

Constructors

LgRepo

Fields

• repoOptions :: RepositoryOptions
• repoObj :: ForeignPtr C'git_repository
• repoExcTrap :: IORef (Maybe GitException)

Instances

(Applicative m, MonadExcept m, MonadUnliftIO m, HasLgRepo m) => MonadGit LgRepo m

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)

Defined in Git.Libgit2

Methods

getRepository :: ReaderT LgRepo m LgRepo

data Options LgRepo

Defined in Git.Libgit2

data Options LgRepo = Options

data Tree LgRepo

Defined in Git.Libgit2

data Tree LgRepo = LgTree {

• lgTreePtr :: Maybe (ForeignPtr C'git_tree)

}

type Oid LgRepo

Defined in Git.Libgit2

type Oid LgRepo = OidPtr

type BlobOid = BlobOid LgRepo

type Commit = Commit LgRepo

type CommitOid = CommitOid LgRepo

type family Oid r :: *

Instances

type Oid LgRepo

Defined in Git.Libgit2

type Oid LgRepo = OidPtr

data OidPtr

Constructors

OidPtr

Fields

• getOid :: ForeignPtr C'git_oid
• getOidLen :: Int

Instances

Eq OidPtr

Defined in Git.Libgit2

Methods

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

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

Ord OidPtr

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

Defined in Git.Libgit2

Methods

showsPrec :: Int -> OidPtr -> ShowS

show :: OidPtr -> String

showList :: [OidPtr] -> ShowS

IsOid OidPtr

Defined in Git.Libgit2

Methods

renderOid :: OidPtr -> Text

renderObjOid :: Tagged a OidPtr -> Text

mkOid :: ForeignPtr C'git_oid -> OidPtr

type Tree = Tree LgRepo

type TreeOid = TreeOid LgRepo

lgRepoPath :: LgRepo -> FilePath

addTracingBackend :: LgRepo -> IO ()

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

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

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

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

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

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

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

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

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

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

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

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

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

oidToSha :: Ptr C'git_oid -> IO SHA

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

shaToOid :: SHA -> IO OidPtr

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

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

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

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

Orphan instances

(Applicative m, MonadExcept m, MonadUnliftIO m, HasLgRepo m) => MonadGit LgRepo m

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)