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.Structs.Note

Description

Represents a note object.

Synopsis

Exported types

newtype Note Source #

Memory-managed wrapper type.

Constructors

Note (ManagedPtr Note) 

Instances

Instances details
Eq Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

Methods

(==) :: Note -> Note -> Bool

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

GBoxed Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

ManagedPtrNewtype Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

Methods

toManagedPtr :: Note -> ManagedPtr Note

TypedObject Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

Methods

glibType :: IO GType

IsGValue Note Source #

Convert Note to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Ggit.Structs.Note

Methods

toGValue :: Note -> IO GValue

fromGValue :: GValue -> IO Note

HasParentTypes Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

type ParentTypes Note Source # 
Instance details

Defined in GI.Ggit.Structs.Note

type ParentTypes Note = '[] :: [Type]

Methods

Overloaded methods

getId

noteGetId Source #

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

Arguments

:: (HasCallStack, MonadIO m) 
=> Note

note: a Note.

-> m (Maybe Text)

Returns: the note message or Nothing.

Gets the note message.

ref

noteRef Source #

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

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.