gi-ostree-1.0.13: OSTree bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.OSTree.Objects.GpgVerifyResult

Description

No description available in the introspection data.

Synopsis

Exported types

newtype GpgVerifyResult Source #

Memory-managed wrapper type.

Constructors

GpgVerifyResult (ManagedPtr GpgVerifyResult) 

Instances

Instances details
Eq GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

GObject GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

ManagedPtrNewtype GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

TypedObject GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

Methods

glibType :: IO GType

IsGValue GpgVerifyResult Source #

Convert GpgVerifyResult to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

Methods

toGValue :: GpgVerifyResult -> IO GValue

fromGValue :: GValue -> IO GpgVerifyResult

HasParentTypes GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

type ParentTypes GpgVerifyResult Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

type ParentTypes GpgVerifyResult = '[Object, Initable]

class (GObject o, IsDescendantOf GpgVerifyResult o) => IsGpgVerifyResult o Source #

Type class for types which can be safely cast to GpgVerifyResult, for instance with toGpgVerifyResult.

Instances

Instances details
(GObject o, IsDescendantOf GpgVerifyResult o) => IsGpgVerifyResult o Source # 
Instance details

Defined in GI.OSTree.Objects.GpgVerifyResult

toGpgVerifyResult :: (MonadIO m, IsGpgVerifyResult o) => o -> m GpgVerifyResult Source #

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

Methods

Overloaded methods

countAll

gpgVerifyResultCountAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> m Word32

Returns: signature count

Counts all the signatures in result.

countValid

gpgVerifyResultCountValid Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> m Word32

Returns: valid signature count

Counts only the valid signatures in result.

describe

gpgVerifyResultDescribe Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> Word32

signatureIndex: which signature to describe

-> String

outputBuffer: a String to hold the description

-> Maybe Text

linePrefix: optional line prefix string

-> GpgSignatureFormatFlags

flags: flags to adjust the description format

-> m () 

Appends a brief, human-readable description of the GPG signature at signatureIndex in result to the outputBuffer. The description spans multiple lines. A linePrefix string, if given, will precede each line of the description.

The flags argument is reserved for future variations to the description format. Currently must be 0.

It is a programmer error to request an invalid signatureIndex. Use gpgVerifyResultCountAll to find the number of signatures in result.

describeVariant

gpgVerifyResultDescribeVariant Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GVariant

variant: a GVariant from gpgVerifyResultGetAll

-> String

outputBuffer: a String to hold the description

-> Maybe Text

linePrefix: optional line prefix string

-> GpgSignatureFormatFlags

flags: flags to adjust the description format

-> m () 

Similar to gpgVerifyResultDescribe but takes a GVariant of all attributes for a GPG signature instead of an GpgVerifyResult and signature index.

The variant <emphasis>MUST</emphasis> have been created by gpgVerifyResultGetAll.

get

gpgVerifyResultGet Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> Word32

signatureIndex: which signature to get attributes from

-> [GpgSignatureAttr]

attrs: Array of requested attributes

-> m GVariant

Returns: a new, floating, GVariant tuple

Builds a GVariant tuple of requested attributes for the GPG signature at signatureIndex in result. See the GpgSignatureAttr description for the VariantType of each available attribute.

It is a programmer error to request an invalid GpgSignatureAttr or an invalid signatureIndex. Use gpgVerifyResultCountAll to find the number of signatures in result.

getAll

gpgVerifyResultGetAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> Word32

signatureIndex: which signature to get attributes from

-> m GVariant

Returns: a new, floating, GVariant tuple

Builds a GVariant tuple of all available attributes for the GPG signature at signatureIndex in result.

The child values in the returned GVariant tuple are ordered to match the GpgSignatureAttr enumeration, which means the enum values can be used as index values in functions like g_variant_get_child(). See the GpgSignatureAttr description for the VariantType of each available attribute.

<note> <para> The GpgSignatureAttr enumeration may be extended in the future with new attributes, which would affect the GVariant tuple returned by this function. While the position and type of current child values in the GVariant tuple will not change, to avoid backward-compatibility issues <emphasis>please do not depend on the tuple's overall size or type signature</emphasis>. </para> </note>

It is a programmer error to request an invalid signatureIndex. Use gpgVerifyResultCountAll to find the number of signatures in result.

lookup

gpgVerifyResultLookup Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> Text

keyId: a GPG key ID or fingerprint

-> m (Bool, Word32)

Returns: True on success, False on failure

Searches result for a signature signed by keyId. If a match is found, the function returns True and sets outSignatureIndex so that further signature details can be obtained through gpgVerifyResultGet. If no match is found, the function returns False and leaves outSignatureIndex unchanged.

requireValidSignature

gpgVerifyResultRequireValidSignature Source #

Arguments

:: (HasCallStack, MonadIO m, IsGpgVerifyResult a) 
=> a

result: an GpgVerifyResult

-> m ()

(Can throw GError)

Checks if the result contains at least one signature from the trusted keyring. You can call this function immediately after repoVerifySummary or repoVerifyCommitExt - it will handle the Nothing result and filled error too.

Since: 2016.6