libfossil
fsl_rebuild_step Struct Reference

State for use with the fsl_rebuild_f() callback type. More...

#include "repo.h"

Collaboration diagram for fsl_rebuild_step:

Data Fields

fsl_size_t artifactCount
 An approximate upper bound on the number of files fsl_repo_rebuild() will process.
fsl_satype_e artifactType
 Set to FSL_SATYPE_INVALID if the just-processed blob is not a fossil artifact, else false.
fsl_int_t blobSize
 The size of the just-processed blob, -1 if it is a phantom blob, or 0 when this object is part of a FSL_MSG_REBUILD_DONE message.
int errCode
 This is only non-0 for FSL_MSG_REBUILD_DONE messages, in which case it holds the result code of the overall rebuild process.
fsl_cx * f
 Fossil context for which this rebuild is being performed.
fsl_rebuild_metrics metrics
 Metrics from the rebuild.
fsl_rebuild_opt const * opt
 The options object used for this invocation of fsl_repo_rebuild().
fsl_id_t rid
 The blob.rid value of the just-processed blob.
fsl_size_t stepNumber
 One-based counter of total artifacts processed so far.

Detailed Description

State for use with the fsl_rebuild_f() callback type.

Definition at line 3736 of file repo.h.

Field Documentation

◆ artifactCount

fsl_size_t fsl_rebuild_step::artifactCount

An approximate upper bound on the number of files fsl_repo_rebuild() will process.

This number is very likely somewhat larger than the number of times which opt->callback() will be called, but it is close enough to give some indication of how far along a rebuild is.

Definition at line 3752 of file repo.h.

◆ artifactType

fsl_satype_e fsl_rebuild_step::artifactType

Set to FSL_SATYPE_INVALID if the just-processed blob is not a fossil artifact, else false.

This will never be set to FSL_SATYPE_ANY.

Definition at line 3780 of file repo.h.

◆ blobSize

fsl_int_t fsl_rebuild_step::blobSize

The size of the just-processed blob, -1 if it is a phantom blob, or 0 when this object is part of a FSL_MSG_REBUILD_DONE message.

Definition at line 3773 of file repo.h.

◆ errCode

int fsl_rebuild_step::errCode

This is only non-0 for FSL_MSG_REBUILD_DONE messages, in which case it holds the result code of the overall rebuild process.

Definition at line 3786 of file repo.h.

◆ f

fsl_cx* fsl_rebuild_step::f

Fossil context for which this rebuild is being performed.

Definition at line 3740 of file repo.h.

◆ metrics

fsl_rebuild_metrics fsl_rebuild_step::metrics

Metrics from the rebuild.

On each rebuild step callback call, these will contain the updated metrics.

Definition at line 3792 of file repo.h.

◆ opt

fsl_rebuild_opt const* fsl_rebuild_step::opt

The options object used for this invocation of fsl_repo_rebuild().

Definition at line 3744 of file repo.h.

◆ rid

fsl_id_t fsl_rebuild_step::rid

The blob.rid value of the just-processed blob.

If stepNumber is 0, this will be 0.

Definition at line 3766 of file repo.h.

◆ stepNumber

fsl_size_t fsl_rebuild_step::stepNumber

One-based counter of total artifacts processed so far.

After rebuilding is finished, opt->callback will be called one final time with this value set to 0. The callback may use the value 0 to recognize that this is post-rebuild step and finalize any output or whatever it wants to do.

Definition at line 3760 of file repo.h.


The documentation for this struct was generated from the following file: