GI.GLib.Structs.LogField

Structure representing a single field in a structured log entry. See g_log_structured() for details.

Log fields may contain arbitrary values, including binary with embedded nul bytes. If the field contains a string, the string must be UTF-8 encoded and have a trailing nul byte. Otherwise, length must be set to a non-negative value.

Since: 2.50

Exported types

newtype LogField

Memory-managed wrapper type.

Constructors

LogField (ManagedPtr LogField)

Instances

Eq LogField

Defined in GI.GLib.Structs.LogField

Methods

(==) :: LogField -> LogField -> Bool

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

BoxedPtr LogField

Defined in GI.GLib.Structs.LogField

Methods

boxedPtrCopy :: LogField -> IO LogField

boxedPtrFree :: LogField -> IO ()

CallocPtr LogField

Defined in GI.GLib.Structs.LogField

Methods

boxedPtrCalloc :: IO (Ptr LogField)

ManagedPtrNewtype LogField

Defined in GI.GLib.Structs.LogField

Methods

toManagedPtr :: LogField -> ManagedPtr LogField

tag ~ 'AttrSet => Constructible LogField tag

Defined in GI.GLib.Structs.LogField

Methods

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

newZeroLogField :: MonadIO m => m LogField

Construct a LogField struct initialized to zero.

Methods

Properties

key

field name (UTF-8 string)

clearLogFieldKey :: MonadIO m => LogField -> m ()

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

clear #key

getLogFieldKey :: MonadIO m => LogField -> m (Maybe Text)

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

get logField #key

setLogFieldKey :: MonadIO m => LogField -> CString -> m ()

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

set logField [ #key := value ]

length

length of value, in bytes, or -1 if it is nul-terminated

getLogFieldLength :: MonadIO m => LogField -> m Int64

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

get logField #length

setLogFieldLength :: MonadIO m => LogField -> Int64 -> m ()

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

set logField [ #length := value ]

value

field value (arbitrary bytes)

clearLogFieldValue :: MonadIO m => LogField -> m ()

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

clear #value

getLogFieldValue :: MonadIO m => LogField -> m (Ptr ())

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

get logField #value

setLogFieldValue :: MonadIO m => LogField -> Ptr () -> m ()

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

set logField [ #value := value ]