libfossil
fsl_ckout_manage_state Struct Reference

State passed to fsl_ckout_manage_f() callback. More...

#include "checkout.h"

Collaboration diagram for fsl_ckout_manage_state:

Data Fields

fsl_cx * f
 The fsl_cx instance for the correspnding fsl_ckout_manage() call.
char const * filename
fsl_ckout_manage_opt const * opt
 The options object passed to the corresponding call to fsl_ckout_manage().

Detailed Description

State passed to fsl_ckout_manage_f() callback.

Definition at line 190 of file checkout.h.

Field Documentation

◆ f

fsl_cx* fsl_ckout_manage_state::f

The fsl_cx instance for the correspnding fsl_ckout_manage() call.

Definition at line 195 of file checkout.h.

◆ filename

char const* fsl_ckout_manage_state::filename
 The name of the file being managed, relative to the root of the
 checkout. fsl_cx_stat2() can be used to transform it to an
 absolute path, if needed. Given a fsl_ckout_manage_state
 named `ms`, that call would look like:

 ```
 fsl_buffer_reuse(&yourBuffer);

^^^ noting that fsl_cx_stat2() APPENDS to the buffer. int rc = fsl_cx_stat2(ms->f, false, ms->filename, NULL, &yourBuffer, true); ^^^ noting that the stat "should not" fail in this case because fsl_ckout_manage() has validated that the file exists. ```

Definition at line 220 of file checkout.h.

◆ opt

fsl_ckout_manage_opt const* fsl_ckout_manage_state::opt

The options object passed to the corresponding call to fsl_ckout_manage().

This is provided primarily for access to its callbackState member. The client must never modify any state in this opt object other than the callbackState or to use other APIs of this->f.

Definition at line 203 of file checkout.h.


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