Safe Haskell	None
Language	Haskell2010

Data.Git.Object

Description

Synopsis

data ObjectType
- = BlobType
- | TreeType
- | CommitType
- | TagType
data Object
- = BlobObj Blob
- | TreeObj Tree
- | CommitObj Commit
- | TagObj Tag
newtype Blob = Blob {
- getBlob :: ByteString
}
newtype Tree = Tree {
- getTree :: Map TreeEntry Sha1
}
data Commit = Commit {
- commitTree :: Sha1
- commitParents :: [Sha1]
- commitAuthor :: (Contact, Date)
- commitCommitter :: (Contact, Date)
- commitMessage :: ByteString
}
data Tag = Tag {
- tagObject :: Sha1
- tagType :: ObjectType
- tagName :: LfFree
- tagTagger :: (Contact, Date)
- tagMessage :: ByteString
}
data TreeEntry = Entry {
- entryName :: PathComponent
- entryMode :: Mode
}
asBlob :: Object -> Maybe Blob
asTree :: Object -> Maybe Tree
asCommit :: Object -> Maybe Commit
asTag :: Object -> Maybe Tag
buildObject :: Object -> Builder
buildLooseObject :: Object -> Builder
emptyTree :: Tree
emptyTreeSha :: Sha1

Documentation

data ObjectType Source #

Objects can be blobs, trees, commits, or tags.

Constructors

BlobType
TreeType
CommitType
TagType

Instances

Eq ObjectType Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: ObjectType -> ObjectType -> Bool # (/=) :: ObjectType -> ObjectType -> Bool #
Ord ObjectType Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: ObjectType -> ObjectType -> Ordering # (<) :: ObjectType -> ObjectType -> Bool # (<=) :: ObjectType -> ObjectType -> Bool # (>) :: ObjectType -> ObjectType -> Bool # (>=) :: ObjectType -> ObjectType -> Bool # max :: ObjectType -> ObjectType -> ObjectType # min :: ObjectType -> ObjectType -> ObjectType #
Show ObjectType Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> ObjectType -> ShowS # show :: ObjectType -> String # showList :: [ObjectType] -> ShowS #

data Object Source #

An Object can be a Blob, a Tree, a Commit, or a Tag.

Constructors

BlobObj Blob
TreeObj Tree
CommitObj Commit
TagObj Tag

Instances

Eq Object Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: Object -> Object -> Bool # (/=) :: Object -> Object -> Bool #
Ord Object Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: Object -> Object -> Ordering # (<) :: Object -> Object -> Bool # (<=) :: Object -> Object -> Bool # (>) :: Object -> Object -> Bool # (>=) :: Object -> Object -> Bool # max :: Object -> Object -> Object # min :: Object -> Object -> Object #
Show Object Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> Object -> ShowS # show :: Object -> String # showList :: [Object] -> ShowS #
HasSha1 Object Source #
Instance details Defined in Data.Git.Internal.Object Methods sha1 :: Object -> Sha1 Source #

newtype Blob Source #

A blob is just some data.

Constructors

Blob
Fields getBlob :: ByteString

Instances

Eq Blob Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: Blob -> Blob -> Bool # (/=) :: Blob -> Blob -> Bool #
Ord Blob Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: Blob -> Blob -> Ordering # (<) :: Blob -> Blob -> Bool # (<=) :: Blob -> Blob -> Bool # (>) :: Blob -> Blob -> Bool # (>=) :: Blob -> Blob -> Bool # max :: Blob -> Blob -> Blob # min :: Blob -> Blob -> Blob #
Show Blob Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> Blob -> ShowS # show :: Blob -> String # showList :: [Blob] -> ShowS #
IsString Blob Source #
Instance details Defined in Data.Git.Internal.Object Methods fromString :: String -> Blob #
HasSha1 Blob Source #
Instance details Defined in Data.Git.Internal.Object Methods sha1 :: Blob -> Sha1 Source #

newtype Tree Source #

Trees map TreeEntrys to the Sha1s of objects.

Constructors

Tree
Fields getTree :: Map TreeEntry Sha1

Instances

Eq Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: Tree -> Tree -> Bool # (/=) :: Tree -> Tree -> Bool #
Ord Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: Tree -> Tree -> Ordering # (<) :: Tree -> Tree -> Bool # (<=) :: Tree -> Tree -> Bool # (>) :: Tree -> Tree -> Bool # (>=) :: Tree -> Tree -> Bool # max :: Tree -> Tree -> Tree # min :: Tree -> Tree -> Tree #
Show Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> Tree -> ShowS # show :: Tree -> String # showList :: [Tree] -> ShowS #
Semigroup Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods (<>) :: Tree -> Tree -> Tree # sconcat :: NonEmpty Tree -> Tree # stimes :: Integral b => b -> Tree -> Tree #
Monoid Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods mempty :: Tree # mappend :: Tree -> Tree -> Tree # mconcat :: [Tree] -> Tree #
HasSha1 Tree Source #
Instance details Defined in Data.Git.Internal.Object Methods sha1 :: Tree -> Sha1 Source #

data Commit Source #

A Commit must point to the Sha1 of a Tree, and can have 0 or more parents (each of which are Commits). A commit with 0 parents is the initial commit in a repo, a commit with 1 parent is a normal commit, and a commit with more than 1 parent is a merge commit.

Constructors

Commit
Fields commitTree :: Sha1 commitParents :: [Sha1] commitAuthor :: (Contact, Date) commitCommitter :: (Contact, Date) commitMessage :: ByteString

Instances

Eq Commit Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: Commit -> Commit -> Bool # (/=) :: Commit -> Commit -> Bool #
Ord Commit Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: Commit -> Commit -> Ordering # (<) :: Commit -> Commit -> Bool # (<=) :: Commit -> Commit -> Bool # (>) :: Commit -> Commit -> Bool # (>=) :: Commit -> Commit -> Bool # max :: Commit -> Commit -> Commit # min :: Commit -> Commit -> Commit #
Show Commit Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> Commit -> ShowS # show :: Commit -> String # showList :: [Commit] -> ShowS #
HasSha1 Commit Source #
Instance details Defined in Data.Git.Internal.Object Methods sha1 :: Commit -> Sha1 Source #

data Tag Source #

A Tag can point to anything, but should probably point to a Commit.

Constructors

Tag
Fields tagObject :: Sha1 tagType :: ObjectType tagName :: LfFree tagTagger :: (Contact, Date) tagMessage :: ByteString

Instances

Eq Tag Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #
Ord Tag Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: Tag -> Tag -> Ordering # (<) :: Tag -> Tag -> Bool # (<=) :: Tag -> Tag -> Bool # (>) :: Tag -> Tag -> Bool # (>=) :: Tag -> Tag -> Bool # max :: Tag -> Tag -> Tag # min :: Tag -> Tag -> Tag #
Show Tag Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
HasSha1 Tag Source #
Instance details Defined in Data.Git.Internal.Object Methods sha1 :: Tag -> Sha1 Source #

data TreeEntry Source #

Trees are composed of entries, each of which has a name and a Mode, which determines what kind of thing it is.

Constructors

Entry
Fields entryName :: PathComponent entryMode :: Mode

Instances

Eq TreeEntry Source #
Instance details Defined in Data.Git.Internal.Object Methods (==) :: TreeEntry -> TreeEntry -> Bool # (/=) :: TreeEntry -> TreeEntry -> Bool #
Ord TreeEntry Source #
Instance details Defined in Data.Git.Internal.Object Methods compare :: TreeEntry -> TreeEntry -> Ordering # (<) :: TreeEntry -> TreeEntry -> Bool # (<=) :: TreeEntry -> TreeEntry -> Bool # (>) :: TreeEntry -> TreeEntry -> Bool # (>=) :: TreeEntry -> TreeEntry -> Bool # max :: TreeEntry -> TreeEntry -> TreeEntry # min :: TreeEntry -> TreeEntry -> TreeEntry #
Show TreeEntry Source #
Instance details Defined in Data.Git.Internal.Object Methods showsPrec :: Int -> TreeEntry -> ShowS # show :: TreeEntry -> String # showList :: [TreeEntry] -> ShowS #

asBlob :: Object -> Maybe Blob Source #

Try to view an Object as a Blob

asTree :: Object -> Maybe Tree Source #

Try to view an Object as a Tree

asCommit :: Object -> Maybe Commit Source #

Try to view an Object as a Commit

asTag :: Object -> Maybe Tag Source #

Try to view an Object as a Tag

buildObject :: Object -> Builder Source #

Build an Object.

buildLooseObject :: Object -> Builder Source #

Build a loose Object.

emptyTree :: Tree Source #

The empty Tree

emptyTreeSha :: Sha1 Source #

The Sha1 of the empty Tree