GI.Ggit.Objects.Signature

Represents an action signature.

Exported types

newtype Signature

Memory-managed wrapper type.

Constructors

Signature (ManagedPtr Signature)

Instances

Eq Signature

Defined in GI.Ggit.Objects.Signature

Methods

(==) :: Signature -> Signature -> Bool

(/=) :: Signature -> Signature -> Bool

IsGValue Signature

Convert Signature to and from GValue with toGValue and fromGValue.

Defined in GI.Ggit.Objects.Signature

Methods

toGValue :: Signature -> IO GValue

fromGValue :: GValue -> IO Signature

GObject Signature

Defined in GI.Ggit.Objects.Signature

Methods

gobjectType :: IO GType

HasParentTypes Signature

Defined in GI.Ggit.Objects.Signature

type ParentTypes Signature

Defined in GI.Ggit.Objects.Signature

type ParentTypes Signature = '[Native, ObjectFactoryBase, Object]

class (GObject o, IsDescendantOf Signature o) => IsSignature o

Type class for types which can be safely cast to Signature, for instance with toSignature.

Instances

(GObject o, IsDescendantOf Signature o) => IsSignature o

Defined in GI.Ggit.Objects.Signature

toSignature :: (MonadIO m, IsSignature o) => o -> m Signature

Cast to Signature, for types for which this is known to be safe. For general casts, use castTo.

noSignature :: Maybe Signature

A convenience alias for Nothing :: Maybe Signature.

Methods

Overloaded methods

copy

signatureCopy

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m (Maybe Signature)

Returns: a Signature or Nothing.

Create a copy of the signature.

getEmail

signatureGetEmail

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m (Maybe Text)

Returns: the email of the person or Nothing.

Gets the email of the person.

getName

signatureGetName

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m (Maybe Text)

Returns: the name of the person or Nothing.

Gets the name of the person.

getTime

signatureGetTime

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m (Maybe DateTime)

Returns: the time when the action happened or Nothing.

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

signatureGetTimeZone

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m (Maybe TimeZone)

Returns: the timezone in which the action happened or Nothing.

Gets the timezone in which the action happened.

new

signatureNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the person.

-> Text

email: the email of the person.

-> DateTime

signatureTime: the time when the action happened.

-> m (Maybe Signature)

Returns: a newly allocated Signature or Nothing. (Can throw GError)

Creates a new Signature. Name and e-mail are assumed to be in UTF-8.

newNow

signatureNewNow

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the person.

-> Text

email: the email of the person.

-> m (Maybe Signature)

Returns: a newly allocated Signature or Nothing. (Can throw GError)

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)

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)

Get the value of the “encoding” property. When overloading is enabled, this is equivalent to

get signature #encoding