debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: deprecate notmuch_query_search_{threads, messages}

Browse source 
The CLI (and bindings) code should really be updated to use the new
status-code-returning versions. Here are some warnings to prod us (and
other clients) to do so.
This commit is contained in:
David Bremner 2015-06-07 17:01:55 +02:00
parent 7e2d0ef105
commit 4fed7047b2
1 changed files with 26 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
lib/notmuch.h
View file

@ -814,19 +814,24 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
* notmuch_threads_destroy function, but there's no good reason * notmuch_threads_destroy function, but there's no good reason
* to call it if the query is about to be destroyed). * 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_status_t
notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_query_search_threads_st (notmuch_query_t *query,
notmuch_threads_t **out); notmuch_threads_t **out);
/**
* Like notmuch_query_search_threads_st, but without a status return.
*
* If a Xapian exception occurs this function will return NULL.
*
* @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please
* use notmuch_query_search_threads_st instead.
*
*/
NOTMUCH_DEPRECATED(4,3)
notmuch_threads_t *
notmuch_query_search_threads (notmuch_query_t *query);
/** /**
* Execute a query for messages, returning a notmuch_messages_t object * Execute a query for messages, returning a notmuch_messages_t object
* which can be used to iterate over the results. The returned * which can be used to iterate over the results. The returned
@ -865,17 +870,23 @@ notmuch_query_search_threads_st (notmuch_query_t *query,
* reason to call it if the query is about to be destroyed). * reason to call it if the query is about to be destroyed).
* *
* If a Xapian exception occurs this function will return NULL. * 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_status_t
notmuch_query_search_messages_st (notmuch_query_t *query, notmuch_query_search_messages_st (notmuch_query_t *query,
notmuch_messages_t **out); notmuch_messages_t **out);
/**
* Like notmuch_query_search_messages, but without a status return.
*
* If a Xapian exception occurs this function will return NULL.
*
* @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please use
* notmuch_query_search_messages_st instead.
*
*/
NOTMUCH_DEPRECATED(4,3)
notmuch_messages_t *
notmuch_query_search_messages (notmuch_query_t *query);
/** /**
* Destroy a notmuch_query_t along with any associated resources. * Destroy a notmuch_query_t along with any associated resources.