Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
Represents an action signature.
Synopsis
- newtype Signature = Signature (ManagedPtr Signature)
- class (GObject o, IsDescendantOf Signature o) => IsSignature o
- toSignature :: (MonadIO m, IsSignature o) => o -> m Signature
- noSignature :: Maybe Signature
- signatureCopy :: (HasCallStack, MonadIO m, IsSignature a) => a -> m (Maybe Signature)
- signatureGetEmail :: (HasCallStack, MonadIO m, IsSignature a) => a -> m (Maybe Text)
- signatureGetName :: (HasCallStack, MonadIO m, IsSignature a) => a -> m (Maybe Text)
- signatureGetTime :: (HasCallStack, MonadIO m, IsSignature a) => a -> m (Maybe DateTime)
- signatureGetTimeZone :: (HasCallStack, MonadIO m, IsSignature a) => a -> m (Maybe TimeZone)
- signatureNew :: (HasCallStack, MonadIO m) => Text -> Text -> DateTime -> m (Maybe Signature)
- signatureNewNow :: (HasCallStack, MonadIO m) => Text -> Text -> m (Maybe Signature)
- constructSignatureEncoding :: IsSignature o => Text -> IO (GValueConstruct o)
- getSignatureEncoding :: (MonadIO m, IsSignature o) => o -> m (Maybe Text)
Exported types
Memory-managed wrapper type.
Instances
GObject Signature Source # | |
Defined in GI.Ggit.Objects.Signature gobjectType :: IO GType # | |
HasParentTypes Signature Source # | |
Defined in GI.Ggit.Objects.Signature | |
type ParentTypes Signature Source # | |
Defined in GI.Ggit.Objects.Signature |
class (GObject o, IsDescendantOf Signature o) => IsSignature o Source #
Type class for types which can be safely cast to Signature
, for instance with toSignature
.
Instances
(GObject o, IsDescendantOf Signature o) => IsSignature o Source # | |
Defined in GI.Ggit.Objects.Signature |
toSignature :: (MonadIO m, IsSignature o) => o -> m Signature Source #
Methods
copy
:: (HasCallStack, MonadIO m, IsSignature a) | |
=> a |
|
-> m (Maybe Signature) |
Create a copy of the signature.
getEmail
:: (HasCallStack, MonadIO m, IsSignature a) | |
=> a |
|
-> m (Maybe Text) | Returns: the email of the person or |
Gets the email of the person.
getName
:: (HasCallStack, MonadIO m, IsSignature a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of the person or |
Gets the name of the person.
getTime
:: (HasCallStack, MonadIO m, IsSignature a) | |
=> a |
|
-> m (Maybe DateTime) | Returns: the time when the action happened or |
Gets the time when the action happened. Note that the time is returned in
the timezone of the commit (see ggit_signature_get_time_zone
).
getTimeZone
:: (HasCallStack, MonadIO m, IsSignature a) | |
=> a |
|
-> m (Maybe TimeZone) | Returns: the timezone in which the action happened or |
Gets the timezone in which the action happened.
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Text |
|
-> DateTime |
|
-> m (Maybe Signature) | Returns: a newly allocated |
Creates a new Signature
. Name and e-mail are assumed to be in UTF-8.
newNow
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> Text |
|
-> m (Maybe Signature) | Returns: a newly allocated |
Creates a new Signature
with a timestamp of 'now'. Name and e-mail are
assumed to be in UTF-8.
Properties
encoding
No description available in the introspection data.
constructSignatureEncoding :: IsSignature o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “encoding
” property. This is rarely needed directly, but it is used by new
.
getSignatureEncoding :: (MonadIO m, IsSignature o) => o -> m (Maybe Text) Source #
Get the value of the “encoding
” property.
When overloading is enabled, this is equivalent to
get
signature #encoding