libfossil
fsl_ckout_rename_opt Struct Reference

Options object for use with fsl_ckout_rename(). More...

#include "checkout.h"

Collaboration diagram for fsl_ckout_rename_opt:

Data Fields

fsl_ckout_rename_f callback
 Optional callback.
void * callbackState
 Optional state for the callback.
char const * dest
 The target filename or directory name to rename to.
bool doFsMv
 If true fsl_ckout_rename() will attempt to move files within the filesystem.
bool dryRun
 If true, fsl_ckout_rename() will not perform any lasting operations but will "go through the motions" with the exception of actually attempting to move files on disk (if doFsMv is true).
bool relativeToCwd
 If true, src and dest are resolved/normalized based on the current working directory, else they must be relative to the top of the checkout.
fsl_list const * src
 The source filename(s) or directory name(s) to rename.

Detailed Description

Options object for use with fsl_ckout_rename().

Definition at line 2961 of file checkout.h.

Field Documentation

◆ callback

fsl_ckout_rename_f fsl_ckout_rename_opt::callback

Optional callback.

May be NULL.

Definition at line 2997 of file checkout.h.

◆ callbackState

void* fsl_ckout_rename_opt::callbackState

Optional state for the callback.

Definition at line 2999 of file checkout.h.

◆ dest

char const* fsl_ckout_rename_opt::dest

The target filename or directory name to rename to.

Definition at line 2971 of file checkout.h.

◆ doFsMv

bool fsl_ckout_rename_opt::doFsMv

If true fsl_ckout_rename() will attempt to move files within the filesystem.

If false, it will only do the db-side renaming.

Definition at line 2982 of file checkout.h.

◆ dryRun

bool fsl_ckout_rename_opt::dryRun

If true, fsl_ckout_rename() will not perform any lasting operations but will "go through the motions" with the exception of actually attempting to move files on disk (if doFsMv is true).

It will still report errors in this mode, with the exception that filesystem-level moving is not attempted so potential failures there cannot be detected.

Achtung: in dry-run mode it will trigger a rollback of any pending transaction which is opened before fsl_ckout_rename() is called.

Definition at line 2995 of file checkout.h.

◆ relativeToCwd

bool fsl_ckout_rename_opt::relativeToCwd

If true, src and dest are resolved/normalized based on the current working directory, else they must be relative to the top of the checkout.

Definition at line 2977 of file checkout.h.

◆ src

fsl_list const* fsl_ckout_rename_opt::src

The source filename(s) or directory name(s) to rename.

The contents of this list must not be modified while fsl_ckout_rename() is running (e.g. via a callback function).

Definition at line 2967 of file checkout.h.


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