GI.Ggit.Structs.Note

Represents a note object.

Exported types

newtype Note

Memory-managed wrapper type.

Constructors

Note (ManagedPtr Note)

Instances

BoxedObject Note

Defined in GI.Ggit.Structs.Note

Methods

boxedType :: Note -> IO GType

noNote :: Maybe Note

A convenience alias for Nothing :: Maybe Note.

Methods

getId

noteGetId

Arguments

:: (HasCallStack, MonadIO m)

=> Note

note: a Note.

-> m (Maybe OId)

Returns: the object's id or Nothing.

Gets the note object's id.

getMessage

noteGetMessage

Arguments

:: (HasCallStack, MonadIO m)

=> Note

note: a Note.

-> m (Maybe Text)

Returns: the note message or Nothing.

Gets the note message.

ref

noteRef

Arguments

:: (HasCallStack, MonadIO m)

=> Note

note: a Note.

-> m (Maybe Note)

Returns: a Note or Nothing.

Atomically increments the reference count of note by one. This function is MT-safe and may be called from any thread.

unref

noteUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Note

note: a Note.

-> m ()

Atomically decrements the reference count of note by one. If the reference count drops to 0, note is freed.