c4DocEnumerator.h

Go to the documentation of this file.

//
// c4DocEnumerator.h
//
// Copyright 2015-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
 
#include "c4DocEnumeratorTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
void c4enum_close(C4DocEnumerator* C4NULLABLE e) C4API;
 
#ifndef C4_STRICT_COLLECTION_API
NODISCARD CBL_CORE_API C4DocEnumerator* c4db_enumerateChanges(C4Database* database, C4SequenceNumber since,
                                                              const C4EnumeratorOptions* C4NULLABLE options,
                                                              C4Error* C4NULLABLE                   outError) C4API;
 
NODISCARD CBL_CORE_API C4DocEnumerator* c4db_enumerateAllDocs(C4Database*                           database,
                                                              const C4EnumeratorOptions* C4NULLABLE options,
                                                              C4Error* C4NULLABLE                   outError) C4API;
#endif
 
NODISCARD CBL_CORE_API C4DocEnumerator* c4coll_enumerateChanges(C4Collection* collection, C4SequenceNumber since,
                                                                const C4EnumeratorOptions* C4NULLABLE options,
                                                                C4Error* C4NULLABLE                   outError) C4API;
 
NODISCARD CBL_CORE_API C4DocEnumerator* c4coll_enumerateAllDocs(C4Collection*                         collection,
                                                                const C4EnumeratorOptions* C4NULLABLE options,
                                                                C4Error* C4NULLABLE                   outError) C4API;
 
NODISCARD CBL_CORE_API bool c4enum_next(C4DocEnumerator* e, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Document* c4enum_getDocument(C4DocEnumerator* e, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4enum_getDocumentInfo(C4DocEnumerator* e, C4DocumentInfo* outInfo) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END