FLKeyPath.h

Go to the documentation of this file.

//
// FLKeyPath.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 _FLKEYPATH_H
#define _FLKEYPATH_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 _FLKeyPath*     FLKeyPath;       
#endif

    NODISCARD FLEECE_PUBLIC FLKeyPath FL_NULLABLE FLKeyPath_New(FLSlice specifier,
                                                                FLError* FL_NULLABLE outError) FLAPI;

    FLEECE_PUBLIC void FLKeyPath_Free(FLKeyPath FL_NULLABLE) FLAPI;

    NODISCARD FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_Eval(FLKeyPath,
                                                               FLValue root) FLAPI;

    NODISCARD FLEECE_PUBLIC FLValue FL_NULLABLE FLKeyPath_EvalOnce(FLSlice specifier, FLValue root,
                                                                   FLError* FL_NULLABLE outError) FLAPI;

    NODISCARD FLEECE_PUBLIC FLStringResult FLKeyPath_ToString(FLKeyPath path) FLAPI;

    FLEECE_PUBLIC bool FLKeyPath_Equals(FLKeyPath path1, FLKeyPath path2) FLAPI;

    FLEECE_PUBLIC size_t FLKeyPath_GetCount(FLKeyPath) FLAPI;

    FLEECE_PUBLIC bool FLKeyPath_GetElement(FLKeyPath path,
                                            size_t i,
                                            FLSlice *outDictKey,
                                            int32_t *outArrayIndex) FLAPI;

    NODISCARD FLEECE_PUBLIC FLKeyPath FL_NULLABLE FLKeyPath_NewEmpty(void) FLAPI;

    FLEECE_PUBLIC void FLKeyPath_AddProperty(FLKeyPath, FLString property) FLAPI;

    FLEECE_PUBLIC void FLKeyPath_AddIndex(FLKeyPath, int index) FLAPI;

    NODISCARD FLEECE_PUBLIC bool FLKeyPath_AddComponents(FLKeyPath, FLString specifier,
                                                         FLError* FL_NULLABLE outError) FLAPI;

    FLEECE_PUBLIC void FLKeyPath_DropComponents(FLKeyPath, size_t n) FLAPI;

 
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END
 
#endif // _FLKEYPATH_H