FLDeepIterator.h

Go to the documentation of this file.

//
// FLDeepIterator.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 _FLDEEPITERATOR_H
#define _FLDEEPITERATOR_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.
 

 
#ifndef FL_IMPL
    typedef struct _FLDeepIterator* FLDeepIterator; 
#endif

    FLEECE_PUBLIC FLDeepIterator FLDeepIterator_New(FLValue FL_NULLABLE) FLAPI;
 
    FLEECE_PUBLIC void FLDeepIterator_Free(FLDeepIterator FL_NULLABLE) FLAPI;

    FLEECE_PUBLIC FLValue FL_NULLABLE FLDeepIterator_GetValue(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC FLValue FL_NULLABLE FLDeepIterator_GetParent(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC FLSlice FLDeepIterator_GetKey(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC uint32_t FLDeepIterator_GetIndex(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC size_t FLDeepIterator_GetDepth(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC void FLDeepIterator_SkipChildren(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC bool FLDeepIterator_Next(FLDeepIterator) FLAPI;
 
    typedef struct {
        FLSlice key;        
        uint32_t index;     
    } FLPathComponent;

    FLEECE_PUBLIC void FLDeepIterator_GetPath(FLDeepIterator,
                                FLPathComponent* FL_NONNULL * FL_NONNULL outPath,
                                size_t* outDepth) FLAPI;

    FLEECE_PUBLIC FLSliceResult FLDeepIterator_GetPathString(FLDeepIterator) FLAPI;

    FLEECE_PUBLIC FLSliceResult FLDeepIterator_GetJSONPointer(FLDeepIterator) FLAPI;

 
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END
 
#endif // _FLDEEPITERATOR_H