libfossil
fsl_repo_extract_opt Struct Reference

Options for use with fsl_repo_extract(). More...

#include "repo.h"

Collaboration diagram for fsl_repo_extract_opt:

Data Fields

fsl_repo_extract_f callback
 The callback to call for each extracted file in the checkin.
void * callbackState
 Optional state pointer to pass to the callback when extracting.
fsl_id_t checkinRid
 The version of the repostitory to check out.
bool extractContent
 If true, the fsl_repo_extract_state::content pointer passed to the callback will be non-NULL and will contain the content of the file.

Detailed Description

Options for use with fsl_repo_extract().

Definition at line 2617 of file repo.h.

Field Documentation

◆ callback

fsl_repo_extract_f fsl_repo_extract_opt::callback

The callback to call for each extracted file in the checkin.

May not be NULL.

Definition at line 2627 of file repo.h.

◆ callbackState

void* fsl_repo_extract_opt::callbackState

Optional state pointer to pass to the callback when extracting.

Its interpretation is client-dependent.

Definition at line 2632 of file repo.h.

◆ checkinRid

fsl_id_t fsl_repo_extract_opt::checkinRid

The version of the repostitory to check out.

This must be the blob.rid of a checkin artifact.

Definition at line 2622 of file repo.h.

◆ extractContent

bool fsl_repo_extract_opt::extractContent

If true, the fsl_repo_extract_state::content pointer passed to the callback will be non-NULL and will contain the content of the file.

If false, that pointer will be NULL. Such extraction is a relatively costly operation, so should only be enabled when necessary. Some uses cases can delay this decision until the callback and only fetch the content for cases which need it.

Definition at line 2641 of file repo.h.


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