GI.Gio.Structs.DBusAnnotationInfo

Information about an annotation.

Since: 2.26

Exported types

newtype DBusAnnotationInfo

Memory-managed wrapper type.

Constructors

DBusAnnotationInfo (ManagedPtr DBusAnnotationInfo)

Instances

BoxedObject DBusAnnotationInfo

Defined in GI.Gio.Structs.DBusAnnotationInfo

Methods

boxedType :: DBusAnnotationInfo -> IO GType

tag ~ AttrSet => Constructible DBusAnnotationInfo tag

Defined in GI.Gio.Structs.DBusAnnotationInfo

Methods

new :: MonadIO m => (ManagedPtr DBusAnnotationInfo -> DBusAnnotationInfo) -> [AttrOp DBusAnnotationInfo tag] -> m DBusAnnotationInfo

newZeroDBusAnnotationInfo :: MonadIO m => m DBusAnnotationInfo

Construct a DBusAnnotationInfo struct initialized to zero.

noDBusAnnotationInfo :: Maybe DBusAnnotationInfo

A convenience alias for Nothing :: Maybe DBusAnnotationInfo.

Methods

lookup

dBusAnnotationInfoLookup

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe [DBusAnnotationInfo]

annotations: A Nothing-terminated array of annotations or Nothing.

-> Text

name: The name of the annotation to look up.

-> m Text

Returns: The value or Nothing if not found. Do not free, it is owned by annotations.

Looks up the value of an annotation.

The cost of this function is O(n) in number of annotations.

Since: 2.26

ref

dBusAnnotationInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> DBusAnnotationInfo

info: A DBusNodeInfo

-> m DBusAnnotationInfo

Returns: The same info.

If info is statically allocated does nothing. Otherwise increases the reference count.

Since: 2.26

unref

dBusAnnotationInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> DBusAnnotationInfo

info: A DBusAnnotationInfo.

-> m ()

If info is statically allocated, does nothing. Otherwise decreases the reference count of info. When its reference count drops to 0, the memory used is freed.

Since: 2.26

Properties

annotations

A pointer to a Nothing-terminated array of pointers to DBusAnnotationInfo structures or Nothing if there are no annotations.

clearDBusAnnotationInfoAnnotations :: MonadIO m => DBusAnnotationInfo -> m ()

Set the value of the “annotations” field to Nothing. When overloading is enabled, this is equivalent to

clear #annotations

getDBusAnnotationInfoAnnotations :: MonadIO m => DBusAnnotationInfo -> m (Maybe [DBusAnnotationInfo])

Get the value of the “annotations” field. When overloading is enabled, this is equivalent to

get dBusAnnotationInfo #annotations

setDBusAnnotationInfoAnnotations :: MonadIO m => DBusAnnotationInfo -> Ptr (Ptr DBusAnnotationInfo) -> m ()

Set the value of the “annotations” field. When overloading is enabled, this is equivalent to

set dBusAnnotationInfo [ #annotations := value ]

key

The name of the annotation, e.g. "org.freedesktop.DBus.Deprecated".

clearDBusAnnotationInfoKey :: MonadIO m => DBusAnnotationInfo -> m ()

Set the value of the “key” field to Nothing. When overloading is enabled, this is equivalent to

clear #key

getDBusAnnotationInfoKey :: MonadIO m => DBusAnnotationInfo -> m (Maybe Text)

Get the value of the “key” field. When overloading is enabled, this is equivalent to

get dBusAnnotationInfo #key

setDBusAnnotationInfoKey :: MonadIO m => DBusAnnotationInfo -> CString -> m ()

Set the value of the “key” field. When overloading is enabled, this is equivalent to

set dBusAnnotationInfo [ #key := value ]

refCount

The reference count or -1 if statically allocated.

getDBusAnnotationInfoRefCount :: MonadIO m => DBusAnnotationInfo -> m Int32

Get the value of the “ref_count” field. When overloading is enabled, this is equivalent to

get dBusAnnotationInfo #refCount

setDBusAnnotationInfoRefCount :: MonadIO m => DBusAnnotationInfo -> Int32 -> m ()

Set the value of the “ref_count” field. When overloading is enabled, this is equivalent to

set dBusAnnotationInfo [ #refCount := value ]

value

The value of the annotation.

clearDBusAnnotationInfoValue :: MonadIO m => DBusAnnotationInfo -> m ()

Set the value of the “value” field to Nothing. When overloading is enabled, this is equivalent to

clear #value

getDBusAnnotationInfoValue :: MonadIO m => DBusAnnotationInfo -> m (Maybe Text)

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

get dBusAnnotationInfo #value

setDBusAnnotationInfoValue :: MonadIO m => DBusAnnotationInfo -> CString -> m ()

Set the value of the “value” field. When overloading is enabled, this is equivalent to

set dBusAnnotationInfo [ #value := value ]