Data.Git.Ref

Documentation

data Ref

represent a git reference (SHA1)

Instances

Eq Ref

Ord Ref

Show Ref

Resolvable Ref

Exceptions

data RefInvalid

Invalid Reference exception raised when using something that is not a ref as a ref.

Constructors

RefInvalid ByteString

Instances

Eq RefInvalid

Data RefInvalid

Show RefInvalid

Exception RefInvalid

data RefNotFound

Reference wasn't found

Constructors

RefNotFound Ref

Instances

Eq RefNotFound

Show RefNotFound

Exception RefNotFound

convert from bytestring and string

isHex :: ByteString -> Bool

isHexString :: String -> Bool

fromHex :: ByteString -> Ref

take a hexadecimal bytestring that represent a reference and turn into a ref

fromHexString :: String -> Ref

take a hexadecimal string that represent a reference and turn into a ref

fromBinary :: ByteString -> Ref

transform a bytestring that represent a binary bytestring and returns a ref.

fromDigest :: Digest SHA1 -> Ref

transform a bytestring that represent a binary bytestring and returns a ref.

toBinary :: Ref -> ByteString

turn a reference into a binary bytestring

toHex :: Ref -> ByteString

transform a ref into an hexadecimal bytestring

toHexString :: Ref -> String

transform a ref into an hexadecimal string

Misc function related to ref

refPrefix :: Ref -> Int

returns the prefix (leading byte) of this reference

cmpPrefix :: String -> Ref -> Ordering

compare prefix

toFilePathParts :: Ref -> (String, String)

returns the splitted format "prefix/suffix" for addressing the loose object database

Hash ByteString types to a ref

hash :: ByteString -> Ref

hash a bytestring into a reference

hashLBS :: ByteString -> Ref

hash a lazy bytestring into a reference