gi-ggit-1.0.9: libgit2-glib bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Ggit.Objects.Signature

Description

Represents an action signature.

Synopsis

Exported types

newtype Signature Source #

Memory-managed wrapper type.

Constructors

Signature (ManagedPtr Signature) 

Instances

Instances details
Eq Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

Methods

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

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

GObject Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

ManagedPtrNewtype Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

Methods

toManagedPtr :: Signature -> ManagedPtr Signature

TypedObject Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

Methods

glibType :: IO GType

IsGValue Signature Source #

Convert Signature to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Objects.Signature

Methods

toGValue :: Signature -> IO GValue

fromGValue :: GValue -> IO Signature

HasParentTypes Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

type ParentTypes Signature Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

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

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

Instances details
(GObject o, IsDescendantOf Signature o) => IsSignature o Source # 
Instance details

Defined in GI.Ggit.Objects.Signature

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

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

Methods

Overloaded methods

copy

signatureCopy Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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, MonadIO m) => Text -> m (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