*
* NOTMUCH_STATUS_SUCCESS: No error occurred.
*
+ * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
+ *
* XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
* value. Instead we should map to things like DATABASE_LOCKED or
* whatever.
*/
typedef enum _notmuch_status {
NOTMUCH_STATUS_SUCCESS = 0,
+ NOTMUCH_STATUS_OUT_OF_MEMORY,
NOTMUCH_STATUS_XAPIAN_EXCEPTION,
NOTMUCH_STATUS_FILE_ERROR,
NOTMUCH_STATUS_FILE_NOT_EMAIL,
typedef struct _notmuch_tags notmuch_tags_t;
typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
+/* Lookup the default database path.
+ *
+ * This is the path that will be used by notmuch_database_create and
+ * notmuch_database_open if given a NULL path. Specifically it will be
+ * the value of the NOTMUCH_BASE environment variable if set,
+ * otherwise ${HOME}/mail
+ *
+ * Returns a newly allocated string which the caller should free()
+ * when finished with it.
+ */
+char *
+notmuch_database_default_path (void);
+
/* Create a new, empty notmuch database located at 'path'.
*
* The path should be a top-level directory to a collection of
notmuch_database_t *
notmuch_database_create (const char *path);
+/* XXX: I think I'd like this to take an extra argument of
+ * notmuch_status_t* for returning a status value on failure. */
+
/* Open a an existing notmuch database located at 'path'.
*
* The database should have been created at some time in the past,
void
notmuch_database_close (notmuch_database_t *database);
-/* Lookup the default database path.
- *
- * This is the path that will be used by notmuch_database_create and
- * notmuch_database_open if given a NULL path. Specifically it will be
- * the value of the NOTMUCH_BASE environment variable if set,
- * otherwise ${HOME}/mail
- *
- * Returns a newly allocated string which the caller should free()
- * when finished with it.
- */
-char *
-notmuch_database_default_path (void);
-
/* Return the database path of the given database.
*
* The return value is a string owned by notmuch so should not be
* a new notmuch_message_t object is returned. The caller should call
* notmuch_message_destroy when done with the message.
*
- * If no message is found with the given message_id, this function
- * returns NULL.
+ * If no message is found with the given message_id or if an
+ * out-of-memory situation occurs, this function returns NULL.
*/
notmuch_message_t *
notmuch_database_find_message (notmuch_database_t *database,
*
* See the documentation of notmuch_query_search for example code
* showing how to iterate over a notmuch_results_t object.
+ *
+ * If an out-of-memory situation occurs, this function will return
+ * NULL.
*/
notmuch_message_t *
notmuch_results_get (notmuch_results_t *results);