libfossil
fsl_repo_extract_state Struct Reference

Callback state for use with fsl_repo_extract_f() implementations to stream a given version of a repository's file's, one file at a time, to a client. More...

#include "fossil-content.h"

Data Fields

fsl_buffer const * content
 Holds the full, undelta'd/uncompressed content of fc's file record. More...
 
fsl_cxf
 The associated Fossil context. More...
 
fsl_card_F const * fc
 The F-card being iterated over. More...
 
fsl_id_t fileRid
 File-level blob.rid for fc. More...
 
void * state
 Client state passed to fsl_repo_extract(). More...
 
fsl_id_t versionRid
 RID of the checkin version for this file. More...
 

Detailed Description

Callback state for use with fsl_repo_extract_f() implementations to stream a given version of a repository's file's, one file at a time, to a client.

Instances are never created by client code, only by fsl_repo_extract() and its delegates, which pass them to client-provided fsl_repo_extract_f() functions.

Definition at line 1968 of file fossil-content.h.

Field Documentation

fsl_buffer const* fsl_repo_extract_state::content

Holds the full, undelta'd/uncompressed content of fc's file record.

The content bytes are owned by fsl_repo_extract() and are invalidated as soon as this callback returns, so the callback must copy/consume them immediately if needed.

Definition at line 1991 of file fossil-content.h.

fsl_cx* fsl_repo_extract_state::f

The associated Fossil context.

Definition at line 1995 of file fossil-content.h.

fsl_card_F const* fsl_repo_extract_state::fc

The F-card being iterated over.

This holds the repo-level metadata associated with the file.

Deleted files are NOT reported via the extraction process because reporting them accurately is trickier and more expensive than it could be. Thus this member's uuid field will always be non-NULL.

Definition at line 1983 of file fossil-content.h.

fsl_id_t fsl_repo_extract_state::fileRid

File-level blob.rid for fc.

Can be used with, e.g., fsl_mtime_of_manifest_file().

It is 0 for files deleted somewhere between the parent and checkin version.

Definition at line 2009 of file fossil-content.h.

void* fsl_repo_extract_state::state

Client state passed to fsl_repo_extract().

Its interpretation is callback-implementation-dependent.

Definition at line 1973 of file fossil-content.h.

fsl_id_t fsl_repo_extract_state::versionRid

RID of the checkin version for this file.

For a given call to fsl_repo_extract(), this number will be the same across all calls to the callback function.

Definition at line 2001 of file fossil-content.h.


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