FLEncoder.h

Go to the documentation of this file.

//
// FLEncoder.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 _FLENCODER_H
#define _FLENCODER_H
 
#include "FLBase.h"
#include <stdio.h>
 
FL_ASSUME_NONNULL_BEGIN
 
#ifdef __cplusplus
extern "C" {
#endif
 
    // This is the C API! For the C++ API, see Fleece.hh.
 

 


    typedef enum {
        kFLEncodeFleece,    
        kFLEncodeJSON,      
        kFLEncodeJSON5      
    } FLEncoderFormat;
 

    NODISCARD FLEECE_PUBLIC FLEncoder FLEncoder_New(void) FLAPI;

    NODISCARD FLEECE_PUBLIC FLEncoder FLEncoder_NewWithOptions(FLEncoderFormat format,
                                       size_t reserveSize,
                                       bool uniqueStrings) FLAPI;

    NODISCARD FLEECE_PUBLIC FLEncoder FLEncoder_NewWritingToFile(FILE*, bool uniqueStrings) FLAPI;

    FLEECE_PUBLIC void FLEncoder_Free(FLEncoder FL_NULLABLE) FLAPI;

    FLEECE_PUBLIC void FLEncoder_SetSharedKeys(FLEncoder, FLSharedKeys FL_NULLABLE) FLAPI;

    FLEECE_PUBLIC void FLEncoder_SetExtraInfo(FLEncoder, void* FL_NULLABLE info) FLAPI;

    FLEECE_PUBLIC void* FLEncoder_GetExtraInfo(FLEncoder) FLAPI;
 

    FLEECE_PUBLIC void FLEncoder_Reset(FLEncoder) FLAPI;

    FLEECE_PUBLIC size_t FLEncoder_BytesWritten(FLEncoder) FLAPI;

 


    FLEECE_PUBLIC bool FLEncoder_WriteNull(FLEncoder) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteUndefined(FLEncoder) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteBool(FLEncoder, bool) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteInt(FLEncoder, int64_t) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteUInt(FLEncoder, uint64_t) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteFloat(FLEncoder, float) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteDouble(FLEncoder, double) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteString(FLEncoder, FLString) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteDateString(FLEncoder encoder, FLTimestamp ts, bool asUTC) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteData(FLEncoder, FLSlice) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteValue(FLEncoder, FLValue) FLAPI;
 

    FLEECE_PUBLIC bool FLEncoder_BeginArray(FLEncoder, size_t reserveCount) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_EndArray(FLEncoder) FLAPI;
 

    FLEECE_PUBLIC bool FLEncoder_BeginDict(FLEncoder, size_t reserveCount) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteKey(FLEncoder, FLString) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_WriteKeyValue(FLEncoder, FLValue) FLAPI;

    FLEECE_PUBLIC bool FLEncoder_EndDict(FLEncoder) FLAPI;
 

    FLEECE_PUBLIC bool FLEncoder_WriteRaw(FLEncoder, FLSlice) FLAPI;

 


    NODISCARD
    FLEECE_PUBLIC FLDoc FL_NULLABLE FLEncoder_FinishDoc(FLEncoder, FLError* FL_NULLABLE outError) FLAPI;

    NODISCARD
    FLEECE_PUBLIC FLSliceResult FLEncoder_Finish(FLEncoder, FLError* FL_NULLABLE outError) FLAPI;

 


    FLEECE_PUBLIC FLError FLEncoder_GetError(FLEncoder) FLAPI;

    FLEECE_PUBLIC const char* FL_NULLABLE FLEncoder_GetErrorMessage(FLEncoder) FLAPI;

 
#ifdef __cplusplus
}
#endif
 
FL_ASSUME_NONNULL_END
 
#endif // _FLENCODER_H