Index

Modules: gittyup.

API symbols

`$`:

• gittyup: proc `$`(buffer: git_buf): string
• gittyup: proc `$`(commit: GitCommit): string
• gittyup: proc `$`(obj: GitObject): string
• gittyup: proc `$`(oid: GitOid): string
• gittyup: proc `$`(ps: GitPathSpec): string
• gittyup: proc `$`(reference: GitReference): string
• gittyup: proc `$`(remote: GitRemote): string
• gittyup: proc `$`(repo: GitRepository): string
• gittyup: proc `$`(walker: GitRevWalker): string
• gittyup: proc `$`(status: GitStatus): string
• gittyup: proc `$`(tag: GitTag): string
• gittyup: proc `$`(tags: GitTagTable): string
• gittyup: proc `$`(thing: GitThing): string
• gittyup: proc `$`(entry: GitTreeEntry): string
• gittyup: proc `$`(annotated: ptr git_annotated_commit): string
• gittyup: proc `$`(buffer: ptr git_buf): string

`:=`:

• gittyup: template `:=`[T](v: untyped{nkIdent}; vv: Result[T, GitResultCode]; body: untyped): untyped

`==`:

• gittyup: proc `==`(a, b: GitOid): bool

author:

• gittyup: proc author(thing: GitThing): GitSignature

branches:

• gittyup: iterator branches(repo: GitRepository; flags = {GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE}): GitResult[ GitReference]

branchName:

• gittyup: proc branchName(got: GitReference): string

branchRemoteName:

• gittyup: proc branchRemoteName(repo: GitRepository; branch: string): GitResult[string]

branchUpstream:

• gittyup: proc branchUpstream(branch: GitReference): GitResult[GitReference]

checkoutHead:

• gittyup: proc checkoutHead(repo: GitRepository; strategy = defaultCheckoutStrategy): GitResultCode

checkoutTree:

• gittyup: proc checkoutTree(repo: GitRepository; thing: GitThing; paths: seq[string] = @[]; strategy = defaultCheckoutStrategy): GitResultCode
• gittyup: proc checkoutTree(repo: GitRepository; reference: string; paths: seq[string] = @[]; strategy = defaultCheckoutStrategy): GitResultCode

clone:

• gittyup: proc clone(uri: Uri; path: string; branch = ""): GitResult[GitRepository]

commit:

• gittyup: proc commit(thing: GitThing): GitCommit

commitsForSpec:

• gittyup: iterator commitsForSpec(repo: GitRepository; spec: openArray[string]): GitResult[GitThing]

committer:

• gittyup: proc committer(thing: GitThing): GitSignature

copy:

• gittyup: proc copy(commit: GitCommit): GitResult[GitCommit]
• gittyup: proc copy(oid: GitOid): GitResult[GitOid]
• gittyup: proc copy(thing: GitThing): GitResult[GitThing]

defaultSignature:

• gittyup: proc defaultSignature(repo: GitRepository): GitResult[GitSignature]
• gittyup: proc defaultSignature(repo: GitRepository; time: Time): GitResult[GitSignature]

dumpError:

• gittyup: proc dumpError(code: GitResultCode): string

err:

• gittyup: template err[T](x: GitResultCode): auto
• gittyup: template err[T](self: var Result[T, GitResultCode]; x: GitResultCode): auto

fetchRemote:

• gittyup: proc fetchRemote(repo: GitRepository; remoteName: string): GitResultCode
• gittyup: proc fetchRemote(repo: GitRepository; remoteName: string; refSpecs: GittyStrArray): GitResultCode

fetchRemotes:

• gittyup: proc fetchRemotes(repo: GitRepository; remoteNames: seq[string]): seq[GitResultCode]

flags:

• gittyup: proc flags(status: GitStatus): set[GitStatusFlag]

free:

• gittyup: proc free(gstrings: var GitStrArray)
• gittyup: proc free(gstrings: var GittyStrArray)
• gittyup: proc free[T: GitHeapGits](point: ptr T)
• gittyup: proc free[T: NimHeapGits](point: ptr T)
• gittyup: proc free(table: sink GitTagTable)
• gittyup: proc free(thing: sink GitThing)
• gittyup: proc free(entries: sink GitTreeEntries)
• gittyup: proc free(s: string)

getHeadOid:

• gittyup: proc getHeadOid(repo: GitRepository): GitResult[GitOid]

getRemoteNames:

• gittyup: proc getRemoteNames(repo: GitRepository): GitResult[seq[string]]

GitBranchType:

• gittyup: type GitBranchType

GitBuf:

• gittyup: type GitBuf

GitCheckoutNotify:

• gittyup: type GitCheckoutNotify

GIT_CHECKOUT_OPTIONS_VERSION:

• gittyup: const GIT_CHECKOUT_OPTIONS_VERSION

GitCheckoutStrategy:

• gittyup: type GitCheckoutStrategy

GIT_CLONE_OPTIONS_VERSION:

• gittyup: const GIT_CLONE_OPTIONS_VERSION

GitCommit:

• gittyup: type GitCommit

GitDiff:

• gittyup: type GitDiff

GIT_DIFF_OPTIONS_VERSION:

• gittyup: const GIT_DIFF_OPTIONS_VERSION

GitErrorClass:

• gittyup: type GitErrorClass

gitFail:

• gittyup: template gitFail(code: GitResultCode; body: untyped)
• gittyup: template gitFail(allocd: typed; code: GitResultCode; body: untyped)

GIT_FETCH_OPTIONS_VERSION:

• gittyup: const GIT_FETCH_OPTIONS_VERSION

GitObject:

• gittyup: type GitObject

GitObjectKind:

• gittyup: type GitObjectKind

GitOid:

• gittyup: type GitOid

GitOids:

• gittyup: type GitOids

GitPathSpec:

• gittyup: type GitPathSpec

GitPathSpecFlag:

• gittyup: type GitPathSpecFlag

GitReference:

• gittyup: type GitReference

GitRemote:

• gittyup: type GitRemote

GitRepository:

• gittyup: type GitRepository

GitRepoState:

• gittyup: type GitRepoState

GitResult:

• gittyup: type GitResult

GitResultCode:

• gittyup: type GitResultCode

GitRevWalker:

• gittyup: type GitRevWalker

GitSignature:

• gittyup: type GitSignature

GitStatus:

• gittyup: type GitStatus

GitStatusFlag:

• gittyup: type GitStatusFlag

GitStatusList:

• gittyup: type GitStatusList

GitStatusOption:

• gittyup: type GitStatusOption

GIT_STATUS_OPTIONS_VERSION:

• gittyup: const GIT_STATUS_OPTIONS_VERSION

GitStatusShow:

• gittyup: type GitStatusShow

GitStrArray:

• gittyup: type GitStrArray

GitTag:

• gittyup: type GitTag

GitTagTable:

• gittyup: type GitTagTable

GitThing:

• gittyup: type GitThing

gitTrap:

• gittyup: template gitTrap(code: GitResultCode; body: untyped)
• gittyup: template gitTrap(allocd: typed; code: GitResultCode; body: untyped)

GitTree:

• gittyup: type GitTree

GitTreeEntries:

• gittyup: type GitTreeEntries

GitTreeEntry:

• gittyup: type GitTreeEntry

GitTreeWalkCallback:

• gittyup: type GitTreeWalkCallback

GitTreeWalkMode:

• gittyup: type GitTreeWalkMode

GittyStrArray:

• gittyup: type GittyStrArray

hash:

• gittyup: proc hash(gcs: GitCheckoutStrategy): Hash
• gittyup: proc hash(oid: GitOid): Hash
• gittyup: proc hash(tag: GitTag): Hash
• gittyup: proc hash(thing: GitThing): Hash

hasThing:

• gittyup: proc hasThing(tags: GitTagTable; thing: GitThing): bool

headReference:

• gittyup: proc headReference(repo: GitRepository): GitResult[GitReference]

init:

• gittyup: proc init(): bool

isBranch:

• gittyup: proc isBranch(got: GitReference): bool

isTag:

• gittyup: proc isTag(got: GitReference): bool

lookupCommit:

• gittyup: proc lookupCommit(repo: GitRepository; oid: GitOid): GitResult[GitThing]

lookupThing:

• gittyup: proc lookupThing(repo: GitRepository; name: string): GitResult[GitThing]

lookupTreeThing:

• gittyup: proc lookupTreeThing(repo: GitRepository; path = "HEAD"): GitResult[GitThing]

message:

• gittyup: proc message(commit: GitCommit): string
• gittyup: proc message(tag: GitTag): string
• gittyup: proc message(thing: GitThing): string

name:

• gittyup: proc name(got: GitReference): string
• gittyup: proc name(remote: GitRemote): string
• gittyup: proc name(entry: GitTreeEntry): string

newPathSpec:

• gittyup: proc newPathSpec(spec: openArray[string]): GitResult[GitPathSpec]

newRevWalk:

• gittyup: proc newRevWalk(repo: GitRepository): GitResult[GitRevWalker]

newSignature:

• gittyup: proc newSignature(name, email: string; time: Time): GitResult[GitSignature]

newTagTable:

• gittyup: proc newTagTable(size = 32): GitTagTable

next:

• gittyup: proc next(walker: GitRevWalker): GitResult[GitOid]

oid:

• gittyup: proc oid(obj: GitObject): GitOid
• gittyup: proc oid(got: GitReference): GitOid
• gittyup: proc oid(tag: GitTag): GitOid
• gittyup: proc oid(thing: GitThing): GitOid
• gittyup: proc oid(entry: GitTreeEntry): GitOid

ok:

• gittyup: template ok[T](self: var Result[T, GitResultCode]; x: T): auto
• gittyup: template ok[T](x: T): auto

openRepository:

• gittyup: proc openRepository(path: string): GitResult[GitRepository]

owner:

• gittyup: proc owner(commit: GitCommit): GitRepository
• gittyup: proc owner(reference: GitReference): GitRepository
• gittyup: proc owner(thing: GitThing): GitRepository

push:

• gittyup: proc push(walker: GitRevWalker; oid: GitOid): GitResultCode

referenceDWIM:

• gittyup: proc referenceDWIM(repo: GitRepository; short: string): GitResult[GitReference]

remoteCreate:

• gittyup: proc remoteCreate(repo: GitRepository; name: string; url: Uri): GitResult[GitRemote]

remoteDelete:

• gittyup: proc remoteDelete(repo: GitRepository; name: string): GitResultCode

remoteLookup:

• gittyup: proc remoteLookup(repo: GitRepository; name: string): GitResult[GitRemote]

remoteRename:

• gittyup: proc remoteRename(repo: GitRepository; prior: string; next: string): GitResult[ seq[string]]

repositoryDiscover:

• gittyup: proc repositoryDiscover(path: string; ceilings: seq[string] = @[]; xfs = true): GitResult[ string]

repositoryHead:

• gittyup: proc repositoryHead(repo: GitRepository): GitResult[GitReference]

repositoryOpen:

• gittyup: proc repositoryOpen(path: string): GitResult[GitRepository]

repositoryPath:

• gittyup: proc repositoryPath(repo: GitRepository): string

repositoryState:

• gittyup: proc repositoryState(repository: GitRepository): GitRepoState

revWalk:

• gittyup: iterator revWalk(repo: GitRepository; walker: GitRevWalker): GitResult[GitThing]

setBranchUpstream:

• gittyup: proc setBranchUpstream(branch: GitReference; name: string): GitResultCode

setHead:

• gittyup: proc setHead(repo: GitRepository; short: string): GitResultCode

setHeadDetached:

• gittyup: proc setHeadDetached(repo: GitRepository; oid: GitOid): GitResultCode
• gittyup: proc setHeadDetached(repo: GitRepository; reference: string): GitResultCode

short:

• gittyup: proc short(oid: GitOid; size: int): GitResult[string]

shortestTag:

• gittyup: proc shortestTag(table: GitTagTable; oid: string): string

shutdown:

• gittyup: proc shutdown(): bool

status:

• gittyup: iterator status(repository: GitRepository; show: GitStatusShow; flags = defaultStatusFlags): GitResult[GitStatus]

summary:

• gittyup: proc summary(commit: GitCommit): string
• gittyup: proc summary(thing: GitThing): string

tagCreate:

• gittyup: proc tagCreate(repo: GitRepository; target: GitThing; name: string; tagger: GitSignature; message = ""; force = false): GitResult[GitOid]
• gittyup: proc tagCreate(repo: GitRepository; target: GitThing; name: string; message = ""; force = false): GitResult[GitOid]
• gittyup: proc tagCreate(target: GitThing; name: string; message = ""; force = false): GitResult[ GitOid]

tagCreateLightweight:

• gittyup: proc tagCreateLightweight(repo: GitRepository; target: GitThing; name: string; force = false): GitResult[GitOid]
• gittyup: proc tagCreateLightweight(target: GitThing; name: string; force = false): GitResult[ GitOid]

tagDelete:

• gittyup: proc tagDelete(repo: GitRepository; name: string): GitResultCode

tagList:

• gittyup: proc tagList(repo: GitRepository): GitResult[seq[string]]

tagTable:

• gittyup: proc tagTable(repo: GitRepository): GitResult[GitTagTable]

target:

• gittyup: proc target(thing: GitThing): GitResult[GitThing]

targetId:

• gittyup: proc targetId(thing: GitThing): GitOid

toStrArray:

• gittyup: proc toStrArray(values: openArray[string]): GittyStrArray

toStringSeq:

• gittyup: proc toStringSeq(gstrings: GitStrArray | GittyStrArray): seq[string]

treeEntryByPath:

• gittyup: proc treeEntryByPath(thing: GitThing; path: string): GitResult[GitTreeEntry]

treeEntryToThing:

• gittyup: proc treeEntryToThing(repo: GitRepository; entry: GitTreeEntry): GitResult[GitThing]

treeWalk:

• gittyup: proc treeWalk(tree: GitThing; mode = GIT_TREEWALK_PRE): GitResult[GitTreeEntries]
• gittyup: proc treeWalk(tree: GitTree; mode: git_treewalk_mode): GitResult[GitTreeEntries]
• gittyup: proc treeWalk(tree: GitTree; mode: git_treewalk_mode; callback: git_treewalk_cb; payload: pointer): git_error_code

url:

• gittyup: proc url(remote: GitRemote): Uri