Portability	unix
Stability	experimental
Maintainer	Vincent Hanquez <vincent@snarc.org>

Data.Git.Object

Contents

parsing function
writing function

Description

Synopsis

Documentation

data ObjectLocation Source

location of an object in the database

Constructors

NotFound
Loose Ref
Packed Ref Word64

Instances

Eq ObjectLocation
Show ObjectLocation

data ObjectType Source

type of a git object.

Constructors

TypeTree
TypeBlob
TypeCommit
TypeTag
TypeDeltaOff
TypeDeltaRef

Instances

Enum ObjectType	the enum instance is useful when marshalling to pack file.
Eq ObjectType
Show ObjectType

type ObjectHeader = (ObjectType, Word64, Maybe ObjectPtr)Source

type ObjectData = ByteString Source

data ObjectPtr Source

Delta objects points to some others objects in the database either as offset in the pack or as a direct reference.

Constructors

PtrRef Ref
PtrOfs Word64

Instances

Eq ObjectPtr
Show ObjectPtr

data Object Source

describe a git object, that could of 6 differents types: tree, blob, commit, tag and deltas (offset or ref). the deltas one are only available through packs.

Constructors

forall a . Objectable a => Object a

data Tree Source

Constructors

Tree
Fields treeGetEnts :: [TreeEnt]

Instances

Eq Tree
Show Tree
Objectable Tree

data Commit Source

Constructors

Commit
Fields commitTreeish :: Ref commitParents :: [Ref] commitAuthor :: Name commitCommitter :: Name commitMessage :: ByteString

Instances

Eq Commit
Show Commit
Objectable Commit

data Blob Source

Constructors

Blob
Fields blobGetContent :: ByteString

Instances

Eq Blob
Show Blob
Objectable Blob

data Tag Source

Constructors

Tag
Fields tagRef :: Ref tagObjectType :: ObjectType tagBlob :: ByteString tagName :: Name tagS :: ByteString

Instances

Eq Tag
Show Tag
Objectable Tag

data DeltaOfs Source

Constructors

DeltaOfs Word64 Delta

Instances

Eq DeltaOfs
Show DeltaOfs
Objectable DeltaOfs

data DeltaRef Source

Constructors

DeltaRef Ref Delta

Instances

Eq DeltaRef
Show DeltaRef
Objectable DeltaRef

data ObjectInfo Source

Raw objects infos have an header (type, size, ptr), the data and a pointers chains to parents for resolved objects.

Constructors

ObjectInfo
Fields oiHeader :: ObjectHeader oiData :: ObjectData oiChains :: [ObjectPtr]

Instances

Eq ObjectInfo
Show ObjectInfo

objectWrap :: Objectable a => a -> Object Source

objectToType :: Object -> ObjectType Source

objectTypeMarshall :: ObjectType -> String Source

objectTypeUnmarshall :: String -> ObjectType Source

objectTypeIsDelta :: ObjectType -> Bool Source

objectIsDelta :: Object -> Bool Source

objectToTree :: Object -> Maybe Tree Source

objectToCommit :: Object -> Maybe Commit Source

objectToTag :: Object -> Maybe Tag Source

objectToBlob :: Object -> Maybe Blob Source

parsing function

treeParse :: Parser ByteString Tree Source

commitParse :: Parser ByteString Commit Source

tagParse :: Parser ByteString Tag Source

blobParse :: Parser ByteString Blob Source

objectParseTree :: Parser ByteString Object Source

objectParseCommit :: Parser ByteString Object Source

objectParseTag :: Parser ByteString Object Source

objectParseBlob :: Parser ByteString Object Source

writing function

objectWriteHeader :: ObjectType -> Word64 -> ByteString Source

parse a tree content

parse a blob content

parse a commit content

parse a tag content

objectWrite :: Object -> ByteString Source

objectHash :: ObjectType -> Word64 -> ByteString -> Ref Source