aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorGravatar Jani Nikula <jani@nikula.org>2011-11-15 22:08:48 +0200
committerGravatar David Bremner <bremner@debian.org>2011-11-15 19:12:32 -0400
commit00c60fbcb3b2b7c9f90c36e4dfb9393fdf678735 (patch)
treea5b1b4736a5d2745efc605774a828dae8e82c814 /lib/notmuch.h
parented20210b6db0b237d48765351cb99b87be7a0509 (diff)
lib: add function to get the number of threads matching a search
Add function notmuch_query_count_threads() to get the number of threads matching a search. This is done by performing a search and figuring out the number of unique thread IDs in the matching messages, a significantly heavier operation than notmuch_query_count_messages(). Signed-off-by: Jani Nikula <jani@nikula.org>
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index c4330e4b..9f23a106 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -609,6 +609,20 @@ notmuch_threads_destroy (notmuch_threads_t *threads);
unsigned
notmuch_query_count_messages (notmuch_query_t *query);
+/* Return the number of threads matching a search.
+ *
+ * This function performs a search and returns the number of unique thread IDs
+ * in the matching messages. This is the same as number of threads matching a
+ * search.
+ *
+ * Note that this is a significantly heavier operation than
+ * notmuch_query_count_messages().
+ *
+ * If an error occurs, this function may return 0.
+ */
+unsigned
+notmuch_query_count_threads (notmuch_query_t *query);
+
/* Get the thread ID of 'thread'.
*
* The returned string belongs to 'thread' and as such, should not be