Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Represents a unique ID of any object.
Synopsis
- newtype OId = OId (ManagedPtr OId)
- oIdCompare :: (HasCallStack, MonadIO m) => OId -> OId -> m Int32
- oIdCopy :: (HasCallStack, MonadIO m) => OId -> m (Maybe OId)
- oIdEqual :: (HasCallStack, MonadIO m) => OId -> OId -> m Bool
- oIdFree :: (HasCallStack, MonadIO m) => OId -> m ()
- oIdHasPrefix :: (HasCallStack, MonadIO m) => OId -> Text -> m Bool
- oIdHash :: (HasCallStack, MonadIO m) => OId -> m Word32
- oIdIsZero :: (HasCallStack, MonadIO m) => OId -> m Bool
- oIdNewFromRaw :: (HasCallStack, MonadIO m) => ByteString -> m (Maybe OId)
- oIdNewFromString :: (HasCallStack, MonadIO m) => Text -> m (Maybe OId)
- oIdToString :: (HasCallStack, MonadIO m) => OId -> m (Maybe Text)
Exported types
Memory-managed wrapper type.
Instances
Eq OId Source # | |
GBoxed OId Source # | |
Defined in GI.Ggit.Structs.OId | |
ManagedPtrNewtype OId Source # | |
Defined in GI.Ggit.Structs.OId toManagedPtr :: OId -> ManagedPtr OId | |
TypedObject OId Source # | |
Defined in GI.Ggit.Structs.OId | |
HasParentTypes OId Source # | |
Defined in GI.Ggit.Structs.OId | |
IsGValue (Maybe OId) Source # | Convert |
Defined in GI.Ggit.Structs.OId gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe OId -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe OId) | |
type ParentTypes OId Source # | |
Defined in GI.Ggit.Structs.OId |
Methods
Click to display all available methods, including inherited ones
compare
:: (HasCallStack, MonadIO m) | |
=> OId |
|
-> OId |
|
-> m Int32 | Returns: <0, 0, >0 if a < b, a == b, a > b. |
Compare two OId
structures.
copy
Copies oid
into a newly allocated OId
.
equal
free
hasPrefix
:: (HasCallStack, MonadIO m) | |
=> OId |
|
-> Text |
|
-> m Bool | Returns: |
Check whether the object id has a given prefix. Note that the prefix is specified in hexadecimal ASCII.
hash
:: (HasCallStack, MonadIO m) | |
=> OId |
|
-> m Word32 | Returns: the hash value |
Computes a hash value for a git object identifier.
isZero
:: (HasCallStack, MonadIO m) | |
=> OId |
|
-> m Bool | Returns: |
Get whether the oid contains only zeros.
newFromRaw
:: (HasCallStack, MonadIO m) | |
=> ByteString |
|
-> m (Maybe OId) |
Creates a new OId
from a raw oid.
newFromString
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe OId) |
Parses a hex formatted object id into a OId
.