GI.Ggit.Objects.Branch

Represents a branch object.

Exported types

newtype Branch

Constructors

Branch (ManagedPtr Branch)

Instances

GObject Branch

Methods

gobjectType :: Branch -> IO GType

IsObject Branch

IsRef Branch

IsObjectFactoryBase Branch

IsNative Branch

IsBranch Branch

class GObject o => IsBranch o

Instances

(GObject a, UnknownAncestorError Constraint Branch a) => IsBranch a

IsBranch Branch

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

noBranch :: Maybe Branch

Methods

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 Text

Returns: the name of the given local or remote branch. (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. (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 Branch

Returns: the new branch. (Can throw GError)

Moves/renames an existing branch reference.