libfossil
fsl_checkin_queue_opt Struct Reference

Options object type used by fsl_checkin_enqueue() and fsl_checkin_dequeue(). More...

#include "checkout.h"

Collaboration diagram for fsl_checkin_queue_opt:

Data Fields

fsl_checkin_queue_f callback
 It not NULL, is pass passed the checkout-relative filename of each enqueued/dequeued file and this->callbackState.
void * callbackState
 Opaque client-side state for use as the 2nd argument to this->callback.
char const * filename
 File or directory name to enqueue/dequeue to/from a pending checkin.
bool onlyModifiedFiles
 If true, only flagged-as-modified files will be enqueued by fsl_checkin_enqueue().
bool relativeToCwd
 If true, filename (if not absolute) is interpreted as relative to the current working directory, else it is assumed to be relative to the top of the current checkout directory.
bool scanForChanges
 If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.
fsl_id_bag const * vfileIds
 If not NULL then this->filename and this->relativeToCwd are IGNORED and any to-queue filename(s) is/are added from this container.

Detailed Description

Options object type used by fsl_checkin_enqueue() and fsl_checkin_dequeue().

Definition at line 822 of file checkout.h.

Field Documentation

◆ callback

fsl_checkin_queue_f fsl_checkin_queue_opt::callback

It not NULL, is pass passed the checkout-relative filename of each enqueued/dequeued file and this->callbackState.

See the callback type's docs for more details.

Definition at line 877 of file checkout.h.

◆ callbackState

void* fsl_checkin_queue_opt::callbackState

Opaque client-side state for use as the 2nd argument to this->callback.

Definition at line 883 of file checkout.h.

◆ filename

char const* fsl_checkin_queue_opt::filename

File or directory name to enqueue/dequeue to/from a pending checkin.

Definition at line 827 of file checkout.h.

◆ onlyModifiedFiles

bool fsl_checkin_queue_opt::onlyModifiedFiles

If true, only flagged-as-modified files will be enqueued by fsl_checkin_enqueue().

By and large, this should be set to true. Setting this to false is generally only intended/useful for testing.

Definition at line 870 of file checkout.h.

◆ relativeToCwd

bool fsl_checkin_queue_opt::relativeToCwd

If true, filename (if not absolute) is interpreted as relative to the current working directory, else it is assumed to be relative to the top of the current checkout directory.

Definition at line 833 of file checkout.h.

◆ scanForChanges

bool fsl_checkin_queue_opt::scanForChanges

If true, fsl_vfile_changes_scan() is called to ensure that the filesystem and vfile tables agree.

If the client code has called that function, or its equivalent, since any changes were made to the checkout then this may be set to false to speed up the enqueue process. This is only used by fsl_checkin_enqueue(), not fsl_checkin_dequeue().

Definition at line 862 of file checkout.h.

◆ vfileIds

fsl_id_bag const* fsl_checkin_queue_opt::vfileIds

If not NULL then this->filename and this->relativeToCwd are IGNORED and any to-queue filename(s) is/are added from this container.

It is an error (FSL_RC_MISUSE) to pass an empty bag. (Should that be FSL_RC_RANGE instead?)

The bag is assumed to contain values from the vfile.id checkout db field, refering to one or more files which should be queued for the pending checkin. It is okay to pass IDs for unmodified files or to queue the same files multiple times. Unmodified files may be enqueued but will be ignored by the checkin process if, at the time the checkin is processed, they are still unmodified. Duplicated entries are simply ignored for the 2nd and subsequent inclusion.

See also
fsl_ckout_vfile_ids()

Definition at line 852 of file checkout.h.


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