GI.Ggit.Objects.Branch

Represents a branch object.

Exported types

newtype Branch

Memory-managed wrapper type.

Constructors

Branch (ManagedPtr Branch)

Instances

Eq Branch

Defined in GI.Ggit.Objects.Branch

Methods

(==) :: Branch -> Branch -> Bool

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

GObject Branch

Defined in GI.Ggit.Objects.Branch

ManagedPtrNewtype Branch

Defined in GI.Ggit.Objects.Branch

Methods

toManagedPtr :: Branch -> ManagedPtr Branch

TypedObject Branch

Defined in GI.Ggit.Objects.Branch

Methods

glibType :: IO GType

HasParentTypes Branch

Defined in GI.Ggit.Objects.Branch

IsGValue (Maybe Branch)

Convert Branch to and from GValue. See toGValue and fromGValue.

Defined in GI.Ggit.Objects.Branch

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Branch -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Branch)

type ParentTypes Branch

Defined in GI.Ggit.Objects.Branch

type ParentTypes Branch = '[Ref, Native, ObjectFactoryBase, Object]

class (GObject o, IsDescendantOf Branch o) => IsBranch o

Type class for types which can be safely cast to Branch, for instance with toBranch.

Instances

(GObject o, IsDescendantOf Branch o) => IsBranch o

Defined in GI.Ggit.Objects.Branch

toBranch :: (MonadIO m, IsBranch o) => o -> m Branch

Cast to Branch, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, delete, deleteLog, forceFloating, freezeNotify, getv, hasLog, isBranch, isFloating, isHead, isNote, isRemote, isTag, lookup, move, notify, notifyByPspec, ref, refSink, rename, resolve, runDispose, stealData, stealQdata, thawNotify, toString, unref, watchClosure.

Getters

getData, getLog, getName, getOwner, getProperty, getQdata, getReferenceType, getShorthand, getSymbolicTarget, getTarget, getUpstream.

Setters

setData, setDataFull, setProperty, setSymbolicTarget, setTarget, setUpstream.

delete

branchDelete

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> m ()

(Can throw GError)

Deletes an existing branch reference.

If the branch is successfully deleted, this object is not useful anymore and if should be freed with objectUnref.

getName

branchGetName

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> m (Maybe Text)

Returns: the name of the given local or remote branch or Nothing. (Can throw GError)

Gets the name of the given local or remote branch.

getUpstream

branchGetUpstream

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> m (Maybe Ref)

Returns: the reference supporting the remote tracking branch or Nothing. (Can throw GError)

Gets the reference supporting the remote tracking branch, given a local branch reference.

isHead

branchIsHead

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> m ()

(Can throw GError)

Determines if the current local branch is pointed at by HEAD.

move

branchMove

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> Text

newBranchName: target name of the branch once the move is performed; this name is validated for consistency.

-> [CreateFlags]

flags: a CreateFlags.

-> m (Maybe Branch)

Returns: the new branch or Nothing. (Can throw GError)

Moves/renames an existing branch reference.

setUpstream

branchSetUpstream

Arguments

:: (HasCallStack, MonadIO m, IsBranch a)

=> a

branch: a Branch.

-> Text

upstreamBranchName: name of the upstream branch; if Nothing unsets it.

-> m ()

(Can throw GError)

Sets the upstream branch, for a given local branch reference