FLBase.h

Go to the documentation of this file.

//
// FLBase.h
//
// Copyright 2016-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#ifndef _FLBASE_H
#define _FLBASE_H
 
#include "CompilerSupport.h"
#include "FLSlice.h"
 
FL_ASSUME_NONNULL_BEGIN
 
#ifdef __cplusplus
extern "C" {
#endif
 
    // This is the C API! For the C++ API, see Fleece.hh.
 
 
    //====== BASIC TYPES
 
#ifndef FL_IMPL
    typedef const struct _FLValue* FLValue;         
    typedef const struct _FLArray* FLArray;         
    typedef const struct _FLDict*  FLDict;          
    typedef struct _FLSlot*        FLSlot;          
    typedef struct _FLArray*       FLMutableArray;  
    typedef struct _FLDict*        FLMutableDict;   
    typedef struct _FLEncoder*     FLEncoder;       
    typedef struct _FLDoc*         FLDoc;           
    typedef struct _FLSharedKeys*  FLSharedKeys;    
#endif
 
 
    typedef enum {
        kFLNoError = 0,
        kFLMemoryError,        // Out of memory, or allocation failed
        kFLOutOfRange,         // Array index or iterator out of range
        kFLInvalidData,        // Bad input data (NaN, non-string key, etc.)
        kFLEncodeError,        // Structural error encoding (missing value, too many ends, etc.)
        kFLJSONError,          // Error parsing JSON
        kFLUnknownValue,       // Unparseable data in a Value (corrupt? Or from some distant future?)
        kFLInternalError,      // Something that shouldn't happen
        kFLNotFound,           // Key not found
        kFLSharedKeysStateError, // Misuse of shared keys (not in transaction, etc.)
        kFLPOSIXError,
        kFLUnsupported,         // Operation is unsupported
    } FLError;
 
 
    typedef enum {
        kFLUntrusted,
        kFLTrusted
    } FLTrust;
 
 
    //====== TIMESTAMPS
 
 
    typedef int64_t FLTimestamp;
 
    #define FLTimestampNone INT64_MIN
 
    FLEECE_PUBLIC FLTimestamp FLTimestamp_Now(void) FLAPI;
 
    FLEECE_PUBLIC FLStringResult FLTimestamp_ToString(FLTimestamp timestamp, bool asUTC) FLAPI;
 
    FLEECE_PUBLIC FLTimestamp FLTimestamp_FromString(FLString str) FLAPI;
 
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END
 
#endif // _FLBASE_H