FLCollections.h

Go to the documentation of this file.

//
// FLCollections.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 _FLCOLLECTIONS_H
#define _FLCOLLECTIONS_H
 
#include "FLBase.h"
 
FL_ASSUME_NONNULL_BEGIN
 
#ifdef __cplusplus
extern "C" {
#endif
 
    // This is the C API! For the C++ API, see Fleece.hh.
 
    //====== ARRAY
 
 
    FLEECE_PUBLIC extern const FLArray kFLEmptyArray;
 
    FLEECE_PUBLIC uint32_t FLArray_Count(FLArray FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC bool FLArray_IsEmpty(FLArray FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLMutableArray FL_NULLABLE FLArray_AsMutable(FLArray FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLArray_Get(FLArray FL_NULLABLE, uint32_t index) FLAPI FLPURE;
 
    typedef struct {
#if !DOXYGEN_PARSING
        void* _private1;
        uint32_t _private2;
        bool _private3;
        void* _private4;
#endif
    } FLArrayIterator;
 
    FLEECE_PUBLIC void FLArrayIterator_Begin(FLArray FL_NULLABLE, FLArrayIterator*) FLAPI;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLArrayIterator_GetValue(const FLArrayIterator*) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLArrayIterator_GetValueAt(const FLArrayIterator*, uint32_t offset) FLAPI FLPURE;
 
    FLEECE_PUBLIC uint32_t FLArrayIterator_GetCount(const FLArrayIterator*) FLAPI FLPURE;
 
    FLEECE_PUBLIC bool FLArrayIterator_Next(FLArrayIterator*) FLAPI;
 
    //====== DICT
 
 
    FLEECE_PUBLIC extern const FLDict kFLEmptyDict;
 
    FLEECE_PUBLIC uint32_t FLDict_Count(FLDict FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC bool FLDict_IsEmpty(FLDict FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLMutableDict FL_NULLABLE FLDict_AsMutable(FLDict FL_NULLABLE) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLDict_Get(FLDict FL_NULLABLE, FLSlice keyString) FLAPI FLPURE;
 
 
    typedef struct {
#if !DOXYGEN_PARSING
        void* _private1;
        uint32_t _private2;
        bool _private3;
        void *_private4, *_private5, *_private6, *_private7;
        int _private8;
#endif
    } FLDictIterator;
 
    FLEECE_PUBLIC void FLDictIterator_Begin(FLDict FL_NULLABLE, FLDictIterator*) FLAPI;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLDictIterator_GetKey(const FLDictIterator*) FLAPI FLPURE;
 
    FLEECE_PUBLIC FLString FLDictIterator_GetKeyString(const FLDictIterator*) FLAPI;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLDictIterator_GetValue(const FLDictIterator*) FLAPI FLPURE;
 
    FLEECE_PUBLIC uint32_t FLDictIterator_GetCount(const FLDictIterator*) FLAPI FLPURE;
 
    FLEECE_PUBLIC bool FLDictIterator_Next(FLDictIterator*) FLAPI;
 
    FLEECE_PUBLIC void FLDictIterator_End(FLDictIterator*) FLAPI;
 
 
    typedef struct {
#if !DOXYGEN_PARSING
        FLSlice _private1;
        void* _private2;
        uint32_t _private3, private4;
        bool private5;
#endif
    } FLDictKey;
 
    FLEECE_PUBLIC FLDictKey FLDictKey_Init(FLSlice string) FLAPI;
 
    FLEECE_PUBLIC FLString FLDictKey_GetString(const FLDictKey*) FLAPI;
 
    FLEECE_PUBLIC FLValue FL_NULLABLE FLDict_GetWithKey(FLDict FL_NULLABLE, FLDictKey*) FLAPI;
 
    
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END
 
#endif // _FLCOLLECTIONS_H