X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=lib%2Fnotmuch.h;h=f0b60b83a4bd2ec7a54be51426a906fcbc71d168;hb=90886f3640ed6aaace84ee7a83a8d2afa2d0c8fb;hp=fe2340bbcbf62470307138aee548427c65a47d3b;hpb=2c9e120e0a2efef63dbd4ec9c4f24beb30ae9167;p=notmuch diff --git a/lib/notmuch.h b/lib/notmuch.h index fe2340bb..f0b60b83 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -55,8 +55,8 @@ NOTMUCH_BEGIN_DECLS * The library version number. This must agree with the soname * version in Makefile.local. */ -#define LIBNOTMUCH_MAJOR_VERSION 3 -#define LIBNOTMUCH_MINOR_VERSION 1 +#define LIBNOTMUCH_MAJOR_VERSION 4 +#define LIBNOTMUCH_MINOR_VERSION 2 #define LIBNOTMUCH_MICRO_VERSION 0 #endif /* __DOXYGEN__ */ @@ -281,7 +281,7 @@ notmuch_database_open (const char *path, notmuch_database_t **database); /** - * Close the given notmuch database. + * Commit changes and close the given notmuch database. * * After notmuch_database_close has been called, calls to other * functions on objects derived from this database may either behave @@ -292,6 +292,13 @@ notmuch_database_open (const char *path, * notmuch_database_close can be called multiple times. Later calls * have no effect. * + * For writable databases, notmuch_database_close commits all changes + * to disk before closing the database. If the caller is currently in + * an atomic section (there was a notmuch_database_begin_atomic + * without a matching notmuch_database_end_atomic), this will discard + * changes made in that atomic section (but still commit changes made + * prior to entering the atomic section). + * * Return value: * * NOTMUCH_STATUS_SUCCESS: Successfully closed the database. @@ -773,10 +780,18 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag); * to call it if the query is about to be destroyed). * * If a Xapian exception occurs this function will return NULL. + * For better error reporting, use the _st variant. */ notmuch_threads_t * notmuch_query_search_threads (notmuch_query_t *query); +/** + * Like notmuch_query_search_threads, but with a status return. + */ +notmuch_status_t +notmuch_query_search_threads_st (notmuch_query_t *query, + notmuch_threads_t **out); + /** * Execute a query for messages, returning a notmuch_messages_t object * which can be used to iterate over the results. The returned @@ -815,10 +830,18 @@ notmuch_query_search_threads (notmuch_query_t *query); * reason to call it if the query is about to be destroyed). * * If a Xapian exception occurs this function will return NULL. + * For better error reporting, use the _st variant. */ notmuch_messages_t * notmuch_query_search_messages (notmuch_query_t *query); +/** + * Like notmuch_query_search_messages, but with a status return. + */ +notmuch_status_t +notmuch_query_search_messages_st (notmuch_query_t *query, + notmuch_messages_t **out); + /** * Destroy a notmuch_query_t along with any associated resources. * @@ -1214,7 +1237,14 @@ notmuch_message_get_filenames (notmuch_message_t *message); */ typedef enum _notmuch_message_flag { NOTMUCH_MESSAGE_FLAG_MATCH, - NOTMUCH_MESSAGE_FLAG_EXCLUDED + NOTMUCH_MESSAGE_FLAG_EXCLUDED, + + /* This message is a "ghost message", meaning it has no filenames + * or content, but we know it exists because it was referenced by + * some other message. A ghost message has only a message ID and + * thread ID. + */ + NOTMUCH_MESSAGE_FLAG_GHOST, } notmuch_message_flag_t; /**