FLDoc.h File Reference

#include "FLBase.h"

Go to the source code of this file.

Macros
#define	_FLDOC_H

Functions
FLDoc
An FLDoc points to (and often owns) Fleece-encoded data and provides access to its Fleece values.
FLEECE_PUBLIC FLDoc	FLDoc_FromResultData (FLSliceResult data, FLTrust, FLSharedKeys FL_NULLABLE, FLSlice externData)
	Creates an FLDoc from Fleece-encoded data that's been returned as a result from FLSlice_Copy or other API. More...
FLEECE_PUBLIC void	FLDoc_Release (FLDoc FL_NULLABLE)
	Releases a reference to an FLDoc. More...
FLEECE_PUBLIC FLDoc	FLDoc_Retain (FLDoc FL_NULLABLE)
	Adds a reference to an FLDoc. More...
FLEECE_PUBLIC FLSlice	FLDoc_GetData (FLDoc FL_NULLABLE) FLPURE
	Returns the encoded Fleece data backing the document. More...
FLEECE_PUBLIC FLSliceResult	FLDoc_GetAllocedData (FLDoc FL_NULLABLE) FLPURE
	Returns the FLSliceResult data owned by the document, if any, else a null slice. More...
FLEECE_PUBLIC FLValue	FLDoc_GetRoot (FLDoc FL_NULLABLE) FLPURE
	Returns the root value in the FLDoc, usually an FLDict. More...
FLEECE_PUBLIC FLSharedKeys	FLDoc_GetSharedKeys (FLDoc FL_NULLABLE) FLPURE
	Returns the FLSharedKeys used by this FLDoc, as specified when it was created. More...
FLEECE_PUBLIC FLDoc FL_NULLABLE	FLValue_FindDoc (FLValue FL_NULLABLE) FLPURE
	Looks up the Doc containing the Value, or NULL if there is none. More...
FLEECE_PUBLIC bool	FLDoc_SetAssociated (FLDoc FL_NULLABLE doc, void *FL_NULLABLE pointer, const char *type)
	Associates an arbitrary pointer value with a document, and thus its contained values. More...
FLEECE_PUBLIC void *	FLDoc_GetAssociated (FLDoc FL_NULLABLE doc, const char *type) FLPURE
	Returns the pointer associated with the document. More...

Macro Definition Documentation

_FLDOC_H

#define _FLDOC_H