Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.OSTree.Structs.Remote

Contents

Exported types
Methods

Description

This represents the configuration for a single remote repository. Currently, remotes can only be passed around as (reference counted) opaque handles. In future, more API may be added to create and interrogate them.

Since: 2018.6

Synopsis

newtype Remote = Remote (ManagedPtr Remote)
remoteGetName :: (HasCallStack, MonadIO m) => Remote -> m Text
remoteGetUrl :: (HasCallStack, MonadIO m) => Remote -> m Text
remoteRef :: (HasCallStack, MonadIO m) => Remote -> m Remote
remoteUnref :: (HasCallStack, MonadIO m) => Remote -> m ()

Exported types

newtype Remote Source #

Memory-managed wrapper type.

Constructors

Remote (ManagedPtr Remote)

Instances

Instances details

Eq Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote Methods (==) :: Remote -> Remote -> Bool # (/=) :: Remote -> Remote -> Bool #
GBoxed Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote
ManagedPtrNewtype Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote Methods toManagedPtr :: Remote -> ManagedPtr Remote
TypedObject Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote Methods glibType :: IO GType
HasParentTypes Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote
IsGValue (Maybe Remote) Source #	Convert `Remote` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.OSTree.Structs.Remote Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Remote -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Remote)
type ParentTypes Remote Source #
Instance details Defined in GI.OSTree.Structs.Remote type ParentTypes Remote = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

getName, getUrl.

Setters

None.

getName

remoteGetName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Remote	`remote`: an `Remote`
-> m Text	Returns: remote’s name

Get the human-readable name of the remote. This is what the user configured, if the remote was explicitly configured; and will otherwise be a stable, arbitrary, string.

Since: 2018.6

getUrl

remoteGetUrl Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Remote	`remote`: an `Remote`
-> m Text	Returns: the remote's URL

Get the URL from the remote.

Since: 2018.6

ref

remoteRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Remote	`remote`: an `Remote`
-> m Remote	Returns: a copy of `remote`, for convenience

Increase the reference count on the given remote.

Since: 2018.6

unref

remoteUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Remote	`remote`: an `Remote`
-> m ()

Decrease the reference count on the given remote and free it if the reference count reaches 0.

Since: 2018.6