evaluation_detail.h

Go to the documentation of this file.

 
// NOLINTBEGIN modernize-use-using
 
#pragma once
 
#include <launchdarkly/bindings/c/export.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {  // only need to export C interface if
// used by C++ source code
#endif
 
typedef struct _LDEvalDetail* LDEvalDetail;
typedef struct _LDEvalReason* LDEvalReason;
 
enum LDEvalReason_Kind {
    // The flag was off and therefore returned its configured off value.
    LD_EVALREASON_OFF = 0,
    // The flag was on but the context did not match any targets or rules.
    LD_EVALREASON_FALLTHROUGH = 1,
    // The context key was specifically targeted for this flag.
    LD_EVALREASON_TARGET_MATCH = 2,
    // The context matched one of the flag's rules.
    LD_EVALREASON_RULE_MATCH = 3,
    // The flag was considered off because it had at least one prerequisite
    // flag that either was off or did not return the desired variation.
    LD_EVALREASON_PREREQUISITE_FAILED = 4,
    // The flag could not be evaluated, e.g. because it does not exist or
    // due to an unexpected error.
    LD_EVALREASON_ERROR = 5
};
 
enum LDEvalReason_ErrorKind {
    // The SDK was not yet fully initialized and cannot evaluate flags.
    LD_EVALREASON_ERROR_CLIENT_NOT_READY = 0,
    // The application did not pass valid context attributes to the SDK
    // evaluation method.
    LD_EVALREASON_ERROR_USER_NOT_SPECIFIED = 1,
    // No flag existed with the specified flag key.
    LD_EVALREASON_ERROR_FLAG_NOT_FOUND = 2,
    // The application requested an evaluation result of one type but the
    // resulting flag variation value was of a different type.
    LD_EVALREASON_ERROR_WRONG_TYPE = 3,
    // The flag had invalid properties.
    LD_EVALREASON_ERROR_MALFORMED_FLAG = 4,
    // An unexpected error happened that stopped evaluation.
    LD_EVALREASON_ERROR_EXCEPTION = 5,
};
 
LD_EXPORT(void)
LDEvalDetail_Free(LDEvalDetail detail);
 
LD_EXPORT(bool)
LDEvalDetail_VariationIndex(LDEvalDetail detail, size_t* out_variation_index);
 
LD_EXPORT(bool)
LDEvalDetail_Reason(LDEvalDetail detail, LDEvalReason* out_reason);
 
LD_EXPORT(enum LDEvalReason_Kind)
LDEvalReason_Kind(LDEvalReason reason);
 
LD_EXPORT(bool)
LDEvalReason_ErrorKind(LDEvalReason reason,
                       enum LDEvalReason_ErrorKind* out_error_kind);
 
LD_EXPORT(bool)
LDEvalReason_InExperiment(LDEvalReason reason);
 
#ifdef __cplusplus
}
#endif
 
// NOLINTEND modernize-use-using