SlHelpers
Loading...
Searching...
No Matches
SlGit::DefaultFetchCallbacks Class Reference

The default FetchCallbacks implementation. More...

#include <DefaultFetchCallbacks.h>

Inheritance diagram for SlGit::DefaultFetchCallbacks:
SlGit::FetchCallbacks

Public Member Functions

 DefaultFetchCallbacks ()
 Construct DefaultFetchCallbacks.
virtual void checkoutProgress (std::string_view path, size_t completedSteps, size_t totalSteps) override
 Called for each path in the tree.
virtual int credentials (git_credential **out, std::string_view url, std::optional< std::string_view > usernameFromUrl, unsigned int allowedTypes) override
 Fill in credentials.
virtual int packProgress (int stage, uint32_t current, uint32_t total) override
 Called many times when packing objects.
virtual int sidebandProgress (std::string_view str) override
 Callback for messages received by the transport.
virtual int transferProgress (const git_indexer_progress &stats) override
 Called many times during download and indexing.
virtual int updateRefs (std::string_view refname, const git_oid &a, const git_oid &b, git_refspec &) override
 Called for each updated reference.
Public Member Functions inherited from SlGit::FetchCallbacks
 FetchCallbacks ()
 Construct FetchCallbacks.

Detailed Description

The default FetchCallbacks implementation.

Member Function Documentation

◆ checkoutProgress()

virtual void SlGit::DefaultFetchCallbacks::checkoutProgress ( std::string_view path,
size_t completedSteps,
size_t totalSteps )
overridevirtual

Called for each path in the tree.

Parameters
pathPath being checked out
completedStepsCount of steps done
totalStepsCount of all steps

Reimplemented from SlGit::FetchCallbacks.

◆ credentials()

virtual int SlGit::DefaultFetchCallbacks::credentials ( git_credential ** cred,
std::string_view url,
std::optional< std::string_view > usernameFromUrl,
unsigned int allowedTypes )
overridevirtual

Fill in credentials.

Parameters
credOutput
urlFor which URL
usernameFromUrlUsername detected in url
allowedTypesGIT_CREDENTIAL_USERNAME, GIT_CREDENTIAL_SSH_KEY, ...
Returns
Zero for success.

Reimplemented from SlGit::FetchCallbacks.

◆ packProgress()

virtual int SlGit::DefaultFetchCallbacks::packProgress ( int stage,
uint32_t current,
uint32_t total )
overridevirtual

Called many times when packing objects.

Parameters
stageAt what stage the packing is (GIT_PACKBUILDER_ADDING_OBJECTS, ...)
currentCurrently packed object
totalTotal number of objects
Returns
Zero for success.

Reimplemented from SlGit::FetchCallbacks.

◆ sidebandProgress()

virtual int SlGit::DefaultFetchCallbacks::sidebandProgress ( std::string_view str)
overridevirtual

Callback for messages received by the transport.

Parameters
strThe message from the transport
Returns
Zero for success.

Reimplemented from SlGit::FetchCallbacks.

◆ transferProgress()

virtual int SlGit::DefaultFetchCallbacks::transferProgress ( const git_indexer_progress & stats)
overridevirtual

Called many times during download and indexing.

Parameters
statsThe statistics
Returns
Zero for success.

Reimplemented from SlGit::FetchCallbacks.

◆ updateRefs()

virtual int SlGit::DefaultFetchCallbacks::updateRefs ( std::string_view refname,
const git_oid & a,
const git_oid & b,
git_refspec & ref )
overridevirtual

Called for each updated reference.

Parameters
refnameThe name of the reference
aThe original OID
bThe new OID
refThe reference structure
Returns
Zero for success.

Reimplemented from SlGit::FetchCallbacks.


The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/slhelpers-20260428.f233ce9-build/slhelpers-20260428.f233ce9/include/git/DefaultFetchCallbacks.h