You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

2708 lines
114 KiB

#![allow(non_camel_case_types)]
#![allow(non_upper_case_globals)]
#![allow(dead_code)]
#![link(name = "notmuch")]
/* automatically generated by rust-bindgen */
pub const _TIME_H: u32 = 1;
pub const _FEATURES_H: u32 = 1;
pub const _DEFAULT_SOURCE: u32 = 1;
pub const __USE_ISOC11: u32 = 1;
pub const __USE_ISOC99: u32 = 1;
pub const __USE_ISOC95: u32 = 1;
pub const __USE_POSIX_IMPLICITLY: u32 = 1;
pub const _POSIX_SOURCE: u32 = 1;
pub const _POSIX_C_SOURCE: u32 = 200809;
pub const __USE_POSIX: u32 = 1;
pub const __USE_POSIX2: u32 = 1;
pub const __USE_POSIX199309: u32 = 1;
pub const __USE_POSIX199506: u32 = 1;
pub const __USE_XOPEN2K: u32 = 1;
pub const __USE_XOPEN2K8: u32 = 1;
pub const _ATFILE_SOURCE: u32 = 1;
pub const __USE_MISC: u32 = 1;
pub const __USE_ATFILE: u32 = 1;
pub const __USE_FORTIFY_LEVEL: u32 = 0;
pub const __GLIBC_USE_DEPRECATED_GETS: u32 = 0;
pub const _STDC_PREDEF_H: u32 = 1;
pub const __STDC_IEC_559__: u32 = 1;
pub const __STDC_IEC_559_COMPLEX__: u32 = 1;
pub const __STDC_ISO_10646__: u32 = 201706;
pub const __GNU_LIBRARY__: u32 = 6;
pub const __GLIBC__: u32 = 2;
pub const __GLIBC_MINOR__: u32 = 28;
pub const _SYS_CDEFS_H: u32 = 1;
pub const __glibc_c99_flexarr_available: u32 = 1;
pub const __WORDSIZE: u32 = 64;
pub const __WORDSIZE_TIME64_COMPAT32: u32 = 1;
pub const __SYSCALL_WORDSIZE: u32 = 64;
pub const __HAVE_GENERIC_SELECTION: u32 = 1;
pub const _BITS_TIME_H: u32 = 1;
pub const _BITS_TYPES_H: u32 = 1;
pub const _BITS_TYPESIZES_H: u32 = 1;
pub const __OFF_T_MATCHES_OFF64_T: u32 = 1;
pub const __INO_T_MATCHES_INO64_T: u32 = 1;
pub const __RLIM_T_MATCHES_RLIM64_T: u32 = 1;
pub const __FD_SETSIZE: u32 = 1024;
pub const CLOCK_REALTIME: u32 = 0;
pub const CLOCK_MONOTONIC: u32 = 1;
pub const CLOCK_PROCESS_CPUTIME_ID: u32 = 2;
pub const CLOCK_THREAD_CPUTIME_ID: u32 = 3;
pub const CLOCK_MONOTONIC_RAW: u32 = 4;
pub const CLOCK_REALTIME_COARSE: u32 = 5;
pub const CLOCK_MONOTONIC_COARSE: u32 = 6;
pub const CLOCK_BOOTTIME: u32 = 7;
pub const CLOCK_REALTIME_ALARM: u32 = 8;
pub const CLOCK_BOOTTIME_ALARM: u32 = 9;
pub const CLOCK_TAI: u32 = 11;
pub const TIMER_ABSTIME: u32 = 1;
pub const __clock_t_defined: u32 = 1;
pub const __time_t_defined: u32 = 1;
pub const __struct_tm_defined: u32 = 1;
pub const _STRUCT_TIMESPEC: u32 = 1;
pub const __clockid_t_defined: u32 = 1;
pub const __timer_t_defined: u32 = 1;
pub const __itimerspec_defined: u32 = 1;
pub const _BITS_TYPES_LOCALE_T_H: u32 = 1;
pub const _BITS_TYPES___LOCALE_T_H: u32 = 1;
pub const TIME_UTC: u32 = 1;
pub const FALSE: u32 = 0;
pub const TRUE: u32 = 1;
pub const LIBNOTMUCH_MAJOR_VERSION: u32 = 5;
pub const LIBNOTMUCH_MINOR_VERSION: u32 = 2;
pub const LIBNOTMUCH_MICRO_VERSION: u32 = 0;
pub const NOTMUCH_TAG_MAX: u32 = 200;
pub type __u_char = ::std::os::raw::c_uchar;
pub type __u_short = ::std::os::raw::c_ushort;
pub type __u_int = ::std::os::raw::c_uint;
pub type __u_long = ::std::os::raw::c_ulong;
pub type __int8_t = ::std::os::raw::c_schar;
pub type __uint8_t = ::std::os::raw::c_uchar;
pub type __int16_t = ::std::os::raw::c_short;
pub type __uint16_t = ::std::os::raw::c_ushort;
pub type __int32_t = ::std::os::raw::c_int;
pub type __uint32_t = ::std::os::raw::c_uint;
pub type __int64_t = ::std::os::raw::c_long;
pub type __uint64_t = ::std::os::raw::c_ulong;
pub type __int_least8_t = __int8_t;
pub type __uint_least8_t = __uint8_t;
pub type __int_least16_t = __int16_t;
pub type __uint_least16_t = __uint16_t;
pub type __int_least32_t = __int32_t;
pub type __uint_least32_t = __uint32_t;
pub type __int_least64_t = __int64_t;
pub type __uint_least64_t = __uint64_t;
pub type __quad_t = ::std::os::raw::c_long;
pub type __u_quad_t = ::std::os::raw::c_ulong;
pub type __intmax_t = ::std::os::raw::c_long;
pub type __uintmax_t = ::std::os::raw::c_ulong;
pub type __dev_t = ::std::os::raw::c_ulong;
pub type __uid_t = ::std::os::raw::c_uint;
pub type __gid_t = ::std::os::raw::c_uint;
pub type __ino_t = ::std::os::raw::c_ulong;
pub type __ino64_t = ::std::os::raw::c_ulong;
pub type __mode_t = ::std::os::raw::c_uint;
pub type __nlink_t = ::std::os::raw::c_ulong;
pub type __off_t = ::std::os::raw::c_long;
pub type __off64_t = ::std::os::raw::c_long;
pub type __pid_t = ::std::os::raw::c_int;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct __fsid_t {
pub __val: [::std::os::raw::c_int; 2usize],
}
#[test]
fn bindgen_test_layout___fsid_t() {
assert_eq!(
::std::mem::size_of::<__fsid_t>(),
8usize,
concat!("Size of: ", stringify!(__fsid_t))
);
assert_eq!(
::std::mem::align_of::<__fsid_t>(),
4usize,
concat!("Alignment of ", stringify!(__fsid_t))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__fsid_t>())).__val as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(__fsid_t),
"::",
stringify!(__val)
)
);
}
pub type __clock_t = ::std::os::raw::c_long;
pub type __rlim_t = ::std::os::raw::c_ulong;
pub type __rlim64_t = ::std::os::raw::c_ulong;
pub type __id_t = ::std::os::raw::c_uint;
pub type __time_t = ::std::os::raw::c_long;
pub type __useconds_t = ::std::os::raw::c_uint;
pub type __suseconds_t = ::std::os::raw::c_long;
pub type __daddr_t = ::std::os::raw::c_int;
pub type __key_t = ::std::os::raw::c_int;
pub type __clockid_t = ::std::os::raw::c_int;
pub type __timer_t = *mut ::std::os::raw::c_void;
pub type __blksize_t = ::std::os::raw::c_long;
pub type __blkcnt_t = ::std::os::raw::c_long;
pub type __blkcnt64_t = ::std::os::raw::c_long;
pub type __fsblkcnt_t = ::std::os::raw::c_ulong;
pub type __fsblkcnt64_t = ::std::os::raw::c_ulong;
pub type __fsfilcnt_t = ::std::os::raw::c_ulong;
pub type __fsfilcnt64_t = ::std::os::raw::c_ulong;
pub type __fsword_t = ::std::os::raw::c_long;
pub type __ssize_t = ::std::os::raw::c_long;
pub type __syscall_slong_t = ::std::os::raw::c_long;
pub type __syscall_ulong_t = ::std::os::raw::c_ulong;
pub type __loff_t = __off64_t;
pub type __caddr_t = *mut ::std::os::raw::c_char;
pub type __intptr_t = ::std::os::raw::c_long;
pub type __socklen_t = ::std::os::raw::c_uint;
pub type __sig_atomic_t = ::std::os::raw::c_int;
pub type clock_t = __clock_t;
pub type time_t = __time_t;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct tm {
pub tm_sec: ::std::os::raw::c_int,
pub tm_min: ::std::os::raw::c_int,
pub tm_hour: ::std::os::raw::c_int,
pub tm_mday: ::std::os::raw::c_int,
pub tm_mon: ::std::os::raw::c_int,
pub tm_year: ::std::os::raw::c_int,
pub tm_wday: ::std::os::raw::c_int,
pub tm_yday: ::std::os::raw::c_int,
pub tm_isdst: ::std::os::raw::c_int,
pub tm_gmtoff: ::std::os::raw::c_long,
pub tm_zone: *const ::std::os::raw::c_char,
}
#[test]
fn bindgen_test_layout_tm() {
assert_eq!(
::std::mem::size_of::<tm>(),
56usize,
concat!("Size of: ", stringify!(tm))
);
assert_eq!(
::std::mem::align_of::<tm>(),
8usize,
concat!("Alignment of ", stringify!(tm))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_sec as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_sec)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_min as *const _ as usize },
4usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_min)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_hour as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_hour)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_mday as *const _ as usize },
12usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_mday)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_mon as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_mon)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_year as *const _ as usize },
20usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_year)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_wday as *const _ as usize },
24usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_wday)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_yday as *const _ as usize },
28usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_yday)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_isdst as *const _ as usize },
32usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_isdst)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_gmtoff as *const _ as usize },
40usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_gmtoff)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<tm>())).tm_zone as *const _ as usize },
48usize,
concat!(
"Offset of field: ",
stringify!(tm),
"::",
stringify!(tm_zone)
)
);
}
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct timespec {
pub tv_sec: __time_t,
pub tv_nsec: __syscall_slong_t,
}
#[test]
fn bindgen_test_layout_timespec() {
assert_eq!(
::std::mem::size_of::<timespec>(),
16usize,
concat!("Size of: ", stringify!(timespec))
);
assert_eq!(
::std::mem::align_of::<timespec>(),
8usize,
concat!("Alignment of ", stringify!(timespec))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<timespec>())).tv_sec as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(timespec),
"::",
stringify!(tv_sec)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<timespec>())).tv_nsec as *const _ as usize },
8usize,
concat!(
"Offset of field: ",
stringify!(timespec),
"::",
stringify!(tv_nsec)
)
);
}
pub type clockid_t = __clockid_t;
pub type timer_t = __timer_t;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct itimerspec {
pub it_interval: timespec,
pub it_value: timespec,
}
#[test]
fn bindgen_test_layout_itimerspec() {
assert_eq!(
::std::mem::size_of::<itimerspec>(),
32usize,
concat!("Size of: ", stringify!(itimerspec))
);
assert_eq!(
::std::mem::align_of::<itimerspec>(),
8usize,
concat!("Alignment of ", stringify!(itimerspec))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<itimerspec>())).it_interval as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(itimerspec),
"::",
stringify!(it_interval)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<itimerspec>())).it_value as *const _ as usize },
16usize,
concat!(
"Offset of field: ",
stringify!(itimerspec),
"::",
stringify!(it_value)
)
);
}
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct sigevent {
_unused: [u8; 0],
}
pub type pid_t = __pid_t;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct __locale_struct {
pub __locales: [*mut __locale_data; 13usize],
pub __ctype_b: *const ::std::os::raw::c_ushort,
pub __ctype_tolower: *const ::std::os::raw::c_int,
pub __ctype_toupper: *const ::std::os::raw::c_int,
pub __names: [*const ::std::os::raw::c_char; 13usize],
}
#[test]
fn bindgen_test_layout___locale_struct() {
assert_eq!(
::std::mem::size_of::<__locale_struct>(),
232usize,
concat!("Size of: ", stringify!(__locale_struct))
);
assert_eq!(
::std::mem::align_of::<__locale_struct>(),
8usize,
concat!("Alignment of ", stringify!(__locale_struct))
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__locale_struct>())).__locales as *const _ as usize },
0usize,
concat!(
"Offset of field: ",
stringify!(__locale_struct),
"::",
stringify!(__locales)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__locale_struct>())).__ctype_b as *const _ as usize },
104usize,
concat!(
"Offset of field: ",
stringify!(__locale_struct),
"::",
stringify!(__ctype_b)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__locale_struct>())).__ctype_tolower as *const _ as usize },
112usize,
concat!(
"Offset of field: ",
stringify!(__locale_struct),
"::",
stringify!(__ctype_tolower)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__locale_struct>())).__ctype_toupper as *const _ as usize },
120usize,
concat!(
"Offset of field: ",
stringify!(__locale_struct),
"::",
stringify!(__ctype_toupper)
)
);
assert_eq!(
unsafe { &(*(::std::ptr::null::<__locale_struct>())).__names as *const _ as usize },
128usize,
concat!(
"Offset of field: ",
stringify!(__locale_struct),
"::",
stringify!(__names)
)
);
}
pub type __locale_t = *mut __locale_struct;
pub type locale_t = __locale_t;
extern "C" {
pub fn clock() -> clock_t;
}
extern "C" {
pub fn time(__timer: *mut time_t) -> time_t;
}
extern "C" {
pub fn difftime(__time1: time_t, __time0: time_t) -> f64;
}
extern "C" {
pub fn mktime(__tp: *mut tm) -> time_t;
}
extern "C" {
pub fn strftime(
__s: *mut ::std::os::raw::c_char,
__maxsize: usize,
__format: *const ::std::os::raw::c_char,
__tp: *const tm,
) -> usize;
}
extern "C" {
pub fn strftime_l(
__s: *mut ::std::os::raw::c_char,
__maxsize: usize,
__format: *const ::std::os::raw::c_char,
__tp: *const tm,
__loc: locale_t,
) -> usize;
}
extern "C" {
pub fn gmtime(__timer: *const time_t) -> *mut tm;
}
extern "C" {
pub fn localtime(__timer: *const time_t) -> *mut tm;
}
extern "C" {
pub fn gmtime_r(__timer: *const time_t, __tp: *mut tm) -> *mut tm;
}
extern "C" {
pub fn localtime_r(__timer: *const time_t, __tp: *mut tm) -> *mut tm;
}
extern "C" {
pub fn asctime(__tp: *const tm) -> *mut ::std::os::raw::c_char;
}
extern "C" {
pub fn ctime(__timer: *const time_t) -> *mut ::std::os::raw::c_char;
}
extern "C" {
pub fn asctime_r(
__tp: *const tm,
__buf: *mut ::std::os::raw::c_char,
) -> *mut ::std::os::raw::c_char;
}
extern "C" {
pub fn ctime_r(
__timer: *const time_t,
__buf: *mut ::std::os::raw::c_char,
) -> *mut ::std::os::raw::c_char;
}
extern "C" {
pub static mut __tzname: [*mut ::std::os::raw::c_char; 2usize];
}
extern "C" {
pub static mut __daylight: ::std::os::raw::c_int;
}
extern "C" {
pub static mut __timezone: ::std::os::raw::c_long;
}
extern "C" {
pub static mut tzname: [*mut ::std::os::raw::c_char; 2usize];
}
extern "C" {
pub fn tzset();
}
extern "C" {
pub static mut daylight: ::std::os::raw::c_int;
}
extern "C" {
pub static mut timezone: ::std::os::raw::c_long;
}
extern "C" {
pub fn stime(__when: *const time_t) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timegm(__tp: *mut tm) -> time_t;
}
extern "C" {
pub fn timelocal(__tp: *mut tm) -> time_t;
}
extern "C" {
pub fn dysize(__year: ::std::os::raw::c_int) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn nanosleep(
__requested_time: *const timespec,
__remaining: *mut timespec,
) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn clock_getres(__clock_id: clockid_t, __res: *mut timespec) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn clock_gettime(__clock_id: clockid_t, __tp: *mut timespec) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn clock_settime(__clock_id: clockid_t, __tp: *const timespec) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn clock_nanosleep(
__clock_id: clockid_t,
__flags: ::std::os::raw::c_int,
__req: *const timespec,
__rem: *mut timespec,
) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn clock_getcpuclockid(__pid: pid_t, __clock_id: *mut clockid_t) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timer_create(
__clock_id: clockid_t,
__evp: *mut sigevent,
__timerid: *mut timer_t,
) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timer_delete(__timerid: timer_t) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timer_settime(
__timerid: timer_t,
__flags: ::std::os::raw::c_int,
__value: *const itimerspec,
__ovalue: *mut itimerspec,
) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timer_gettime(__timerid: timer_t, __value: *mut itimerspec) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timer_getoverrun(__timerid: timer_t) -> ::std::os::raw::c_int;
}
extern "C" {
pub fn timespec_get(
__ts: *mut timespec,
__base: ::std::os::raw::c_int,
) -> ::std::os::raw::c_int;
}
#[doc = " Notmuch boolean type."]
pub type notmuch_bool_t = ::std::os::raw::c_int;
#[doc = " No error occurred."]
pub const _notmuch_status_NOTMUCH_STATUS_SUCCESS: _notmuch_status = 0;
#[doc = " Out of memory."]
pub const _notmuch_status_NOTMUCH_STATUS_OUT_OF_MEMORY: _notmuch_status = 1;
#[doc = " An attempt was made to write to a database opened in read-only"]
#[doc = " mode."]
pub const _notmuch_status_NOTMUCH_STATUS_READ_ONLY_DATABASE: _notmuch_status = 2;
#[doc = " A Xapian exception occurred."]
#[doc = ""]
#[doc = " @todo We don't really want to expose this lame XAPIAN_EXCEPTION"]
#[doc = " value. Instead we should map to things like DATABASE_LOCKED or"]
#[doc = " whatever."]
pub const _notmuch_status_NOTMUCH_STATUS_XAPIAN_EXCEPTION: _notmuch_status = 3;
#[doc = " An error occurred trying to read or write to a file (this could"]
#[doc = " be file not found, permission denied, etc.)"]
pub const _notmuch_status_NOTMUCH_STATUS_FILE_ERROR: _notmuch_status = 4;
#[doc = " A file was presented that doesn't appear to be an email"]
#[doc = " message."]
pub const _notmuch_status_NOTMUCH_STATUS_FILE_NOT_EMAIL: _notmuch_status = 5;
#[doc = " A file contains a message ID that is identical to a message"]
#[doc = " already in the database."]
pub const _notmuch_status_NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: _notmuch_status = 6;
#[doc = " The user erroneously passed a NULL pointer to a notmuch"]
#[doc = " function."]
pub const _notmuch_status_NOTMUCH_STATUS_NULL_POINTER: _notmuch_status = 7;
#[doc = " A tag value is too long (exceeds NOTMUCH_TAG_MAX)."]
pub const _notmuch_status_NOTMUCH_STATUS_TAG_TOO_LONG: _notmuch_status = 8;
#[doc = " The notmuch_message_thaw function has been called more times"]
#[doc = " than notmuch_message_freeze."]
pub const _notmuch_status_NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: _notmuch_status = 9;
#[doc = " notmuch_database_end_atomic has been called more times than"]
#[doc = " notmuch_database_begin_atomic."]
pub const _notmuch_status_NOTMUCH_STATUS_UNBALANCED_ATOMIC: _notmuch_status = 10;
#[doc = " The operation is not supported."]
pub const _notmuch_status_NOTMUCH_STATUS_UNSUPPORTED_OPERATION: _notmuch_status = 11;
#[doc = " The operation requires a database upgrade."]
pub const _notmuch_status_NOTMUCH_STATUS_UPGRADE_REQUIRED: _notmuch_status = 12;
#[doc = " There is a problem with the proposed path, e.g. a relative path"]
#[doc = " passed to a function expecting an absolute path."]
pub const _notmuch_status_NOTMUCH_STATUS_PATH_ERROR: _notmuch_status = 13;
#[doc = " The requested operation was ignored. Depending on the function,"]
#[doc = " this may not be an actual error."]
pub const _notmuch_status_NOTMUCH_STATUS_IGNORED: _notmuch_status = 14;
#[doc = " One of the arguments violates the preconditions for the"]
#[doc = " function, in a way not covered by a more specific argument."]
pub const _notmuch_status_NOTMUCH_STATUS_ILLEGAL_ARGUMENT: _notmuch_status = 15;
#[doc = " A MIME object claimed to have cryptographic protection which"]
#[doc = " notmuch tried to handle, but the protocol was not specified in"]
#[doc = " an intelligible way."]
pub const _notmuch_status_NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL: _notmuch_status = 16;
#[doc = " Notmuch attempted to do crypto processing, but could not"]
#[doc = " initialize the engine needed to do so."]
pub const _notmuch_status_NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION: _notmuch_status = 17;
#[doc = " A MIME object claimed to have cryptographic protection, and"]
#[doc = " notmuch attempted to process it, but the specific protocol was"]
#[doc = " something that notmuch doesn't know how to handle."]
pub const _notmuch_status_NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL: _notmuch_status = 18;
#[doc = " Not an actual status value. Just a way to find out how many"]
#[doc = " valid status values there are."]
pub const _notmuch_status_NOTMUCH_STATUS_LAST_STATUS: _notmuch_status = 19;
#[doc = " Status codes used for the return values of most functions."]
#[doc = ""]
#[doc = " A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function"]
#[doc = " completed without error. Any other value indicates an error."]
pub type _notmuch_status = u32;
pub use self::_notmuch_status as notmuch_status_t;
extern "C" {
#[doc = " Get a string representation of a notmuch_status_t value."]
#[doc = ""]
#[doc = " The result is read-only."]
pub fn notmuch_status_to_string(status: notmuch_status_t) -> *const ::std::os::raw::c_char;
}
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_database {
_unused: [u8; 0],
}
pub type notmuch_database_t = _notmuch_database;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_query {
_unused: [u8; 0],
}
pub type notmuch_query_t = _notmuch_query;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_threads {
_unused: [u8; 0],
}
pub type notmuch_threads_t = _notmuch_threads;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_thread {
_unused: [u8; 0],
}
pub type notmuch_thread_t = _notmuch_thread;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_messages {
_unused: [u8; 0],
}
pub type notmuch_messages_t = _notmuch_messages;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_message {
_unused: [u8; 0],
}
pub type notmuch_message_t = _notmuch_message;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_tags {
_unused: [u8; 0],
}
pub type notmuch_tags_t = _notmuch_tags;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_directory {
_unused: [u8; 0],
}
pub type notmuch_directory_t = _notmuch_directory;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_filenames {
_unused: [u8; 0],
}
pub type notmuch_filenames_t = _notmuch_filenames;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_config_list {
_unused: [u8; 0],
}
pub type notmuch_config_list_t = _notmuch_config_list;
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct _notmuch_indexopts {
_unused: [u8; 0],
}
pub type notmuch_indexopts_t = _notmuch_indexopts;
extern "C" {
#[doc = " Create a new, empty notmuch database located at 'path'."]
#[doc = ""]
#[doc = " The path should be a top-level directory to a collection of"]
#[doc = " plain-text email messages (one message per file). This call will"]
#[doc = " create a new \".notmuch\" directory within 'path' where notmuch will"]
#[doc = " store its data."]
#[doc = ""]
#[doc = " After a successful call to notmuch_database_create, the returned"]
#[doc = " database will be open so the caller should call"]
#[doc = " notmuch_database_destroy when finished with it."]
#[doc = ""]
#[doc = " The database will not yet have any data in it"]
#[doc = " (notmuch_database_create itself is a very cheap function). Messages"]
#[doc = " contained within 'path' can be added to the database by calling"]
#[doc = " notmuch_database_index_file."]
#[doc = ""]
#[doc = " In case of any failure, this function returns an error status and"]
#[doc = " sets *database to NULL (after printing an error message on stderr)."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully created the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the"]
#[doc = "\tdatabase file (such as permission denied, or file not found,"]
#[doc = "\tetc.), or the database already exists."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred."]
pub fn notmuch_database_create(
path: *const ::std::os::raw::c_char,
database: *mut *mut notmuch_database_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Like notmuch_database_create, except optionally return an error"]
#[doc = " message. This message is allocated by malloc and should be freed by"]
#[doc = " the caller."]
pub fn notmuch_database_create_verbose(
path: *const ::std::os::raw::c_char,
database: *mut *mut notmuch_database_t,
error_message: *mut *mut ::std::os::raw::c_char,
) -> notmuch_status_t;
}
#[doc = " Open database for reading only."]
pub const notmuch_database_mode_t_NOTMUCH_DATABASE_MODE_READ_ONLY: notmuch_database_mode_t = 0;
#[doc = " Open database for reading and writing."]
pub const notmuch_database_mode_t_NOTMUCH_DATABASE_MODE_READ_WRITE: notmuch_database_mode_t = 1;
#[doc = " Database open mode for notmuch_database_open."]
pub type notmuch_database_mode_t = u32;
extern "C" {
#[doc = " Open an existing notmuch database located at 'path'."]
#[doc = ""]
#[doc = " The database should have been created at some time in the past,"]
#[doc = " (not necessarily by this process), by calling"]
#[doc = " notmuch_database_create with 'path'. By default the database should be"]
#[doc = " opened for reading only. In order to write to the database you need to"]
#[doc = " pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode."]
#[doc = ""]
#[doc = " An existing notmuch database can be identified by the presence of a"]
#[doc = " directory named \".notmuch\" below 'path'."]
#[doc = ""]
#[doc = " The caller should call notmuch_database_destroy when finished with"]
#[doc = " this database."]
#[doc = ""]
#[doc = " In case of any failure, this function returns an error status and"]
#[doc = " sets *database to NULL (after printing an error message on stderr)."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully opened the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the"]
#[doc = "\tdatabase file (such as permission denied, or file not found,"]
#[doc = "\tetc.), or the database version is unknown."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred."]
pub fn notmuch_database_open(
path: *const ::std::os::raw::c_char,
mode: notmuch_database_mode_t,
database: *mut *mut notmuch_database_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Like notmuch_database_open, except optionally return an error"]
#[doc = " message. This message is allocated by malloc and should be freed by"]
#[doc = " the caller."]
pub fn notmuch_database_open_verbose(
path: *const ::std::os::raw::c_char,
mode: notmuch_database_mode_t,
database: *mut *mut notmuch_database_t,
error_message: *mut *mut ::std::os::raw::c_char,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Retrieve last status string for given database."]
#[doc = ""]
pub fn notmuch_database_status_string(
notmuch: *const notmuch_database_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Commit changes and close the given notmuch database."]
#[doc = ""]
#[doc = " After notmuch_database_close has been called, calls to other"]
#[doc = " functions on objects derived from this database may either behave"]
#[doc = " as if the database had not been closed (e.g., if the required data"]
#[doc = " has been cached) or may fail with a"]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation"]
#[doc = " permitted on the database itself is to call"]
#[doc = " notmuch_database_destroy."]
#[doc = ""]
#[doc = " notmuch_database_close can be called multiple times. Later calls"]
#[doc = " have no effect."]
#[doc = ""]
#[doc = " For writable databases, notmuch_database_close commits all changes"]
#[doc = " to disk before closing the database. If the caller is currently in"]
#[doc = " an atomic section (there was a notmuch_database_begin_atomic"]
#[doc = " without a matching notmuch_database_end_atomic), this will discard"]
#[doc = " changes made in that atomic section (but still commit changes made"]
#[doc = " prior to entering the atomic section)."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully closed the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the"]
#[doc = "\tdatabase has been closed but there are no guarantees the"]
#[doc = "\tchanges to the database, if any, have been flushed to disk."]
pub fn notmuch_database_close(database: *mut notmuch_database_t) -> notmuch_status_t;
}
#[doc = " A callback invoked by notmuch_database_compact to notify the user"]
#[doc = " of the progress of the compaction process."]
pub type notmuch_compact_status_cb_t = ::std::option::Option<
unsafe extern "C" fn(
message: *const ::std::os::raw::c_char,
closure: *mut ::std::os::raw::c_void,
),
>;
extern "C" {
#[doc = " Compact a notmuch database, backing up the original database to the"]
#[doc = " given path."]
#[doc = ""]
#[doc = " The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE"]
#[doc = " during the compaction process to ensure no writes are made."]
#[doc = ""]
#[doc = " If the optional callback function 'status_cb' is non-NULL, it will"]
#[doc = " be called with diagnostic and informational messages. The argument"]
#[doc = " 'closure' is passed verbatim to any callback invoked."]
pub fn notmuch_database_compact(
path: *const ::std::os::raw::c_char,
backup_path: *const ::std::os::raw::c_char,
status_cb: notmuch_compact_status_cb_t,
closure: *mut ::std::os::raw::c_void,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Destroy the notmuch database, closing it if necessary and freeing"]
#[doc = " all associated resources."]
#[doc = ""]
#[doc = " Return value as in notmuch_database_close if the database was open;"]
#[doc = " notmuch_database_destroy itself has no failure modes."]
pub fn notmuch_database_destroy(database: *mut notmuch_database_t) -> notmuch_status_t;
}
extern "C" {
#[doc = " Return the database path of the given database."]
#[doc = ""]
#[doc = " The return value is a string owned by notmuch so should not be"]
#[doc = " modified nor freed by the caller."]
pub fn notmuch_database_get_path(
database: *mut notmuch_database_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Return the database format version of the given database."]
pub fn notmuch_database_get_version(
database: *mut notmuch_database_t,
) -> ::std::os::raw::c_uint;
}
extern "C" {
#[doc = " Can the database be upgraded to a newer database version?"]
#[doc = ""]
#[doc = " If this function returns TRUE, then the caller may call"]
#[doc = " notmuch_database_upgrade to upgrade the database. If the caller"]
#[doc = " does not upgrade an out-of-date database, then some functions may"]
#[doc = " fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns"]
#[doc = " FALSE for a read-only database because there's no way to upgrade a"]
#[doc = " read-only database."]
pub fn notmuch_database_needs_upgrade(database: *mut notmuch_database_t) -> notmuch_bool_t;
}
extern "C" {
#[doc = " Upgrade the current database to the latest supported version."]
#[doc = ""]
#[doc = " This ensures that all current notmuch functionality will be"]
#[doc = " available on the database. After opening a database in read-write"]
#[doc = " mode, it is recommended that clients check if an upgrade is needed"]
#[doc = " (notmuch_database_needs_upgrade) and if so, upgrade with this"]
#[doc = " function before making any modifications. If"]
#[doc = " notmuch_database_needs_upgrade returns FALSE, this will be a no-op."]
#[doc = ""]
#[doc = " The optional progress_notify callback can be used by the caller to"]
#[doc = " provide progress indication to the user. If non-NULL it will be"]
#[doc = " called periodically with 'progress' as a floating-point value in"]
#[doc = " the range of [0.0 .. 1.0] indicating the progress made so far in"]
#[doc = " the upgrade process. The argument 'closure' is passed verbatim to"]
#[doc = " any callback invoked."]
pub fn notmuch_database_upgrade(
database: *mut notmuch_database_t,
progress_notify: ::std::option::Option<
unsafe extern "C" fn(closure: *mut ::std::os::raw::c_void, progress: f64),
>,
closure: *mut ::std::os::raw::c_void,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Begin an atomic database operation."]
#[doc = ""]
#[doc = " Any modifications performed between a successful begin and a"]
#[doc = " notmuch_database_end_atomic will be applied to the database"]
#[doc = " atomically. Note that, unlike a typical database transaction, this"]
#[doc = " only ensures atomicity, not durability; neither begin nor end"]
#[doc = " necessarily flush modifications to disk."]
#[doc = ""]
#[doc = " Atomic sections may be nested. begin_atomic and end_atomic must"]
#[doc = " always be called in pairs."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;"]
#[doc = "\tatomic section not entered."]
pub fn notmuch_database_begin_atomic(notmuch: *mut notmuch_database_t) -> notmuch_status_t;
}
extern "C" {
#[doc = " Indicate the end of an atomic database operation."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;"]
#[doc = "\tatomic section not ended."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in"]
#[doc = "\tan atomic section."]
pub fn notmuch_database_end_atomic(notmuch: *mut notmuch_database_t) -> notmuch_status_t;
}
extern "C" {
#[doc = " Return the committed database revision and UUID."]
#[doc = ""]
#[doc = " The database revision number increases monotonically with each"]
#[doc = " commit to the database. Hence, all messages and message changes"]
#[doc = " committed to the database (that is, visible to readers) have a last"]
#[doc = " modification revision <= the committed database revision. Any"]
#[doc = " messages committed in the future will be assigned a modification"]
#[doc = " revision > the committed database revision."]
#[doc = ""]
#[doc = " The UUID is a NUL-terminated opaque string that uniquely identifies"]
#[doc = " this database. Two revision numbers are only comparable if they"]
#[doc = " have the same database UUID."]
pub fn notmuch_database_get_revision(
notmuch: *mut notmuch_database_t,
uuid: *mut *const ::std::os::raw::c_char,
) -> ::std::os::raw::c_ulong;
}
extern "C" {
#[doc = " Retrieve a directory object from the database for 'path'."]
#[doc = ""]
#[doc = " Here, 'path' should be a path relative to the path of 'database'"]
#[doc = " (see notmuch_database_get_path), or else should be an absolute path"]
#[doc = " with initial components that match the path of 'database'."]
#[doc = ""]
#[doc = " If this directory object does not exist in the database, this"]
#[doc = " returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL."]
#[doc = ""]
#[doc = " Otherwise the returned directory object is owned by the database"]
#[doc = " and as such, will only be valid until notmuch_database_destroy is"]
#[doc = " called."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;"]
#[doc = "\tdirectory not retrieved."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the"]
#[doc = " database to use this function."]
pub fn notmuch_database_get_directory(
database: *mut notmuch_database_t,
path: *const ::std::os::raw::c_char,
directory: *mut *mut notmuch_directory_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Add a message file to a database, indexing it for retrieval by"]
#[doc = " future searches. If a message already exists with the same message"]
#[doc = " ID as the specified file, their indexes will be merged, and this"]
#[doc = " new filename will also be associated with the existing message."]
#[doc = ""]
#[doc = " Here, 'filename' should be a path relative to the path of"]
#[doc = " 'database' (see notmuch_database_get_path), or else should be an"]
#[doc = " absolute filename with initial components that match the path of"]
#[doc = " 'database'."]
#[doc = ""]
#[doc = " The file should be a single mail message (not a multi-message mbox)"]
#[doc = " that is expected to remain at its current location, (since the"]
#[doc = " notmuch database will reference the filename, and will not copy the"]
#[doc = " entire contents of the file."]
#[doc = ""]
#[doc = " If another message with the same message ID already exists in the"]
#[doc = " database, rather than creating a new message, this adds the search"]
#[doc = " terms from the identified file to the existing message's index, and"]
#[doc = " adds 'filename' to the list of filenames known for the message."]
#[doc = ""]
#[doc = " The 'indexopts' parameter can be NULL (meaning, use the indexing"]
#[doc = " defaults from the database), or can be an explicit choice of"]
#[doc = " indexing options that should govern the indexing of this specific"]
#[doc = " 'filename'."]
#[doc = ""]
#[doc = " If 'message' is not NULL, then, on successful return"]
#[doc = " (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'"]
#[doc = " will be initialized to a message object that can be used for things"]
#[doc = " such as adding tags to the just-added message. The user should call"]
#[doc = " notmuch_message_destroy when done with the message. On any failure"]
#[doc = " '*message' will be set to NULL."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Message successfully added to database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,"]
#[doc = "\tmessage not added."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message"]
#[doc = "\tID as another message already in the database. The new"]
#[doc = "\tfilename was successfully added to the message in the database"]
#[doc = "\t(if not already present) and the existing message is returned."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the"]
#[doc = "\tfile, (such as permission denied, or file not found,"]
#[doc = "\tetc.). Nothing added to the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look"]
#[doc = "\tlike an email message. Nothing added to the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only"]
#[doc = "\tmode so no message can be added."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the"]
#[doc = " database to use this function."]
#[doc = ""]
#[doc = " @since libnotmuch 5.1 (notmuch 0.26)"]
pub fn notmuch_database_index_file(
database: *mut notmuch_database_t,
filename: *const ::std::os::raw::c_char,
indexopts: *mut notmuch_indexopts_t,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Deprecated alias for notmuch_database_index_file called with"]
#[doc = " NULL indexopts."]
#[doc = ""]
#[doc = " @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please"]
#[doc = " use notmuch_database_index_file instead."]
#[doc = ""]
pub fn notmuch_database_add_message(
database: *mut notmuch_database_t,
filename: *const ::std::os::raw::c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Remove a message filename from the given notmuch database. If the"]
#[doc = " message has no more filenames, remove the message."]
#[doc = ""]
#[doc = " If the same message (as determined by the message ID) is still"]
#[doc = " available via other filenames, then the message will persist in the"]
#[doc = " database for those filenames. When the last filename is removed for"]
#[doc = " a particular message, the database content for that message will be"]
#[doc = " entirely removed."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: The last filename was removed and the"]
#[doc = "\tmessage was removed from the database."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,"]
#[doc = "\tmessage not removed."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but"]
#[doc = "\tthe message persists in the database with at least one other"]
#[doc = "\tfilename."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only"]
#[doc = "\tmode so no message can be removed."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the"]
#[doc = " database to use this function."]
pub fn notmuch_database_remove_message(
database: *mut notmuch_database_t,
filename: *const ::std::os::raw::c_char,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Find a message with the given message_id."]
#[doc = ""]
#[doc = " If a message with the given message_id is found then, on successful return"]
#[doc = " (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message"]
#[doc = " object. The caller should call notmuch_message_destroy when done with the"]
#[doc = " message."]
#[doc = ""]
#[doc = " On any failure or when the message is not found, this function initializes"]
#[doc = " '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the"]
#[doc = " caller is supposed to check '*message' for NULL to find out whether the"]
#[doc = " message with the given message_id was found."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred"]
pub fn notmuch_database_find_message(
database: *mut notmuch_database_t,
message_id: *const ::std::os::raw::c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Find a message with the given filename."]
#[doc = ""]
#[doc = " If the database contains a message with the given filename then, on"]
#[doc = " successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to"]
#[doc = " a message object. The caller should call notmuch_message_destroy when done"]
#[doc = " with the message."]
#[doc = ""]
#[doc = " On any failure or when the message is not found, this function initializes"]
#[doc = " '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the"]
#[doc = " caller is supposed to check '*message' for NULL to find out whether the"]
#[doc = " message with the given filename is found."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the"]
#[doc = " database to use this function."]
pub fn notmuch_database_find_message_by_filename(
notmuch: *mut notmuch_database_t,
filename: *const ::std::os::raw::c_char,
message: *mut *mut notmuch_message_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Return a list of all tags found in the database."]
#[doc = ""]
#[doc = " This function creates a list of all tags found in the database. The"]
#[doc = " resulting list contains all tags from all messages found in the database."]
#[doc = ""]
#[doc = " On error this function returns NULL."]
pub fn notmuch_database_get_all_tags(db: *mut notmuch_database_t) -> *mut notmuch_tags_t;
}
extern "C" {
#[doc = " Create a new query for 'database'."]
#[doc = ""]
#[doc = " Here, 'database' should be an open database, (see"]
#[doc = " notmuch_database_open and notmuch_database_create)."]
#[doc = ""]
#[doc = " For the query string, we'll document the syntax here more"]
#[doc = " completely in the future, but it's likely to be a specialized"]
#[doc = " version of the general Xapian query syntax:"]
#[doc = ""]
#[doc = " https://xapian.org/docs/queryparser.html"]
#[doc = ""]
#[doc = " As a special case, passing either a length-zero string, (that is \"\"),"]
#[doc = " or a string consisting of a single asterisk (that is \"*\"), will"]
#[doc = " result in a query that returns all messages in the database."]
#[doc = ""]
#[doc = " See notmuch_query_set_sort for controlling the order of results."]
#[doc = " See notmuch_query_search_messages and notmuch_query_search_threads"]
#[doc = " to actually execute the query."]
#[doc = ""]
#[doc = " User should call notmuch_query_destroy when finished with this"]
#[doc = " query."]
#[doc = ""]
#[doc = " Will return NULL if insufficient memory is available."]
pub fn notmuch_query_create(
database: *mut notmuch_database_t,
query_string: *const ::std::os::raw::c_char,
) -> *mut notmuch_query_t;
}
#[doc = " Oldest first."]
pub const notmuch_sort_t_NOTMUCH_SORT_OLDEST_FIRST: notmuch_sort_t = 0;
#[doc = " Newest first."]
pub const notmuch_sort_t_NOTMUCH_SORT_NEWEST_FIRST: notmuch_sort_t = 1;
#[doc = " Sort by message-id."]
pub const notmuch_sort_t_NOTMUCH_SORT_MESSAGE_ID: notmuch_sort_t = 2;
#[doc = " Do not sort."]
pub const notmuch_sort_t_NOTMUCH_SORT_UNSORTED: notmuch_sort_t = 3;
#[doc = " Sort values for notmuch_query_set_sort."]
pub type notmuch_sort_t = u32;
extern "C" {
#[doc = " Return the query_string of this query. See notmuch_query_create."]
pub fn notmuch_query_get_query_string(
query: *const notmuch_query_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Return the notmuch database of this query. See notmuch_query_create."]
pub fn notmuch_query_get_database(query: *const notmuch_query_t) -> *mut notmuch_database_t;
}
pub const notmuch_exclude_t_NOTMUCH_EXCLUDE_FLAG: notmuch_exclude_t = 0;
pub const notmuch_exclude_t_NOTMUCH_EXCLUDE_TRUE: notmuch_exclude_t = 1;
pub const notmuch_exclude_t_NOTMUCH_EXCLUDE_FALSE: notmuch_exclude_t = 2;
pub const notmuch_exclude_t_NOTMUCH_EXCLUDE_ALL: notmuch_exclude_t = 3;
#[doc = " Exclude values for notmuch_query_set_omit_excluded. The strange"]
#[doc = " order is to maintain backward compatibility: the old FALSE/TRUE"]
#[doc = " options correspond to the new"]
#[doc = " NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options."]
pub type notmuch_exclude_t = u32;
extern "C" {
#[doc = " Specify whether to omit excluded results or simply flag them. By"]
#[doc = " default, this is set to TRUE."]
#[doc = ""]
#[doc = " If set to TRUE or ALL, notmuch_query_search_messages will omit excluded"]
#[doc = " messages from the results, and notmuch_query_search_threads will omit"]
#[doc = " threads that match only in excluded messages. If set to TRUE,"]
#[doc = " notmuch_query_search_threads will include all messages in threads that"]
#[doc = " match in at least one non-excluded message. Otherwise, if set to ALL,"]
#[doc = " notmuch_query_search_threads will omit excluded messages from all threads."]
#[doc = ""]
#[doc = " If set to FALSE or FLAG then both notmuch_query_search_messages and"]
#[doc = " notmuch_query_search_threads will return all matching"]
#[doc = " messages/threads regardless of exclude status. If set to FLAG then"]
#[doc = " the exclude flag will be set for any excluded message that is"]
#[doc = " returned by notmuch_query_search_messages, and the thread counts"]
#[doc = " for threads returned by notmuch_query_search_threads will be the"]
#[doc = " number of non-excluded messages/matches. Otherwise, if set to"]
#[doc = " FALSE, then the exclude status is completely ignored."]
#[doc = ""]
#[doc = " The performance difference when calling"]
#[doc = " notmuch_query_search_messages should be relatively small (and both"]
#[doc = " should be very fast). However, in some cases,"]
#[doc = " notmuch_query_search_threads is very much faster when omitting"]
#[doc = " excluded messages as it does not need to construct the threads that"]
#[doc = " only match in excluded messages."]
pub fn notmuch_query_set_omit_excluded(
query: *mut notmuch_query_t,
omit_excluded: notmuch_exclude_t,
);
}
extern "C" {
#[doc = " Specify the sorting desired for this query."]
pub fn notmuch_query_set_sort(query: *mut notmuch_query_t, sort: notmuch_sort_t);
}
extern "C" {
#[doc = " Return the sort specified for this query. See"]
#[doc = " notmuch_query_set_sort."]
pub fn notmuch_query_get_sort(query: *const notmuch_query_t) -> notmuch_sort_t;
}
extern "C" {
#[doc = " Add a tag that will be excluded from the query results by default."]
#[doc = " This exclusion will be ignored if this tag appears explicitly in"]
#[doc = " the query."]
#[doc = ""]
#[doc = " @returns"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: excluded was added successfully."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred."]
#[doc = " Most likely a problem lazily parsing the query string."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so"]
#[doc = "\t\tnot excluded."]
pub fn notmuch_query_add_tag_exclude(
query: *mut notmuch_query_t,
tag: *const ::std::os::raw::c_char,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Execute a query for threads, returning a notmuch_threads_t object"]
#[doc = " which can be used to iterate over the results. The returned threads"]
#[doc = " object is owned by the query and as such, will only be valid until"]
#[doc = " notmuch_query_destroy."]
#[doc = ""]
#[doc = " Typical usage might be:"]
#[doc = ""]
#[doc = " notmuch_query_t *query;"]
#[doc = " notmuch_threads_t *threads;"]
#[doc = " notmuch_thread_t *thread;"]
#[doc = " notmuch_status_t stat;"]
#[doc = ""]
#[doc = " query = notmuch_query_create (database, query_string);"]
#[doc = ""]
#[doc = " for (stat = notmuch_query_search_threads (query, &threads);"]
#[doc = "\t stat == NOTMUCH_STATUS_SUCCESS &&"]
#[doc = " notmuch_threads_valid (threads);"]
#[doc = " notmuch_threads_move_to_next (threads))"]
#[doc = " {"]
#[doc = " thread = notmuch_threads_get (threads);"]
#[doc = " ...."]
#[doc = " notmuch_thread_destroy (thread);"]
#[doc = " }"]
#[doc = ""]
#[doc = " notmuch_query_destroy (query);"]
#[doc = ""]
#[doc = " Note: If you are finished with a thread before its containing"]
#[doc = " query, you can call notmuch_thread_destroy to clean up some memory"]
#[doc = " sooner (as in the above example). Otherwise, if your thread objects"]
#[doc = " are long-lived, then you don't need to call notmuch_thread_destroy"]
#[doc = " and all the memory will still be reclaimed when the query is"]
#[doc = " destroyed."]
#[doc = ""]
#[doc = " Note that there's no explicit destructor needed for the"]
#[doc = " notmuch_threads_t object. (For consistency, we do provide a"]
#[doc = " notmuch_threads_destroy function, but there's no good reason"]
#[doc = " to call it if the query is about to be destroyed)."]
#[doc = ""]
#[doc = " @since libnotmuch 5.0 (notmuch 0.25)"]
pub fn notmuch_query_search_threads(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_threads_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Deprecated alias for notmuch_query_search_threads."]
#[doc = ""]
#[doc = " @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please"]
#[doc = " use notmuch_query_search_threads instead."]
#[doc = ""]
pub fn notmuch_query_search_threads_st(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_threads_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Execute a query for messages, returning a notmuch_messages_t object"]
#[doc = " which can be used to iterate over the results. The returned"]
#[doc = " messages object is owned by the query and as such, will only be"]
#[doc = " valid until notmuch_query_destroy."]
#[doc = ""]
#[doc = " Typical usage might be:"]
#[doc = ""]
#[doc = " notmuch_query_t *query;"]
#[doc = " notmuch_messages_t *messages;"]
#[doc = " notmuch_message_t *message;"]
#[doc = ""]
#[doc = " query = notmuch_query_create (database, query_string);"]
#[doc = ""]
#[doc = " for (messages = notmuch_query_search_messages (query);"]
#[doc = " notmuch_messages_valid (messages);"]
#[doc = " notmuch_messages_move_to_next (messages))"]
#[doc = " {"]
#[doc = " message = notmuch_messages_get (messages);"]
#[doc = " ...."]
#[doc = " notmuch_message_destroy (message);"]
#[doc = " }"]
#[doc = ""]
#[doc = " notmuch_query_destroy (query);"]
#[doc = ""]
#[doc = " Note: If you are finished with a message before its containing"]
#[doc = " query, you can call notmuch_message_destroy to clean up some memory"]
#[doc = " sooner (as in the above example). Otherwise, if your message"]
#[doc = " objects are long-lived, then you don't need to call"]
#[doc = " notmuch_message_destroy and all the memory will still be reclaimed"]
#[doc = " when the query is destroyed."]
#[doc = ""]
#[doc = " Note that there's no explicit destructor needed for the"]
#[doc = " notmuch_messages_t object. (For consistency, we do provide a"]
#[doc = " notmuch_messages_destroy function, but there's no good"]
#[doc = " reason to call it if the query is about to be destroyed)."]
#[doc = ""]
#[doc = " If a Xapian exception occurs this function will return NULL."]
#[doc = ""]
#[doc = " @since libnotmuch 5 (notmuch 0.25)"]
pub fn notmuch_query_search_messages(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_messages_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Deprecated alias for notmuch_query_search_messages"]
#[doc = ""]
#[doc = " @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use"]
#[doc = " notmuch_query_search_messages instead."]
#[doc = ""]
pub fn notmuch_query_search_messages_st(
query: *mut notmuch_query_t,
out: *mut *mut notmuch_messages_t,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Destroy a notmuch_query_t along with any associated resources."]
#[doc = ""]
#[doc = " This will in turn destroy any notmuch_threads_t and"]
#[doc = " notmuch_messages_t objects generated by this query, (and in"]
#[doc = " turn any notmuch_thread_t and notmuch_message_t objects generated"]
#[doc = " from those results, etc.), if such objects haven't already been"]
#[doc = " destroyed."]
pub fn notmuch_query_destroy(query: *mut notmuch_query_t);
}
extern "C" {
#[doc = " Is the given 'threads' iterator pointing at a valid thread."]
#[doc = ""]
#[doc = " When this function returns TRUE, notmuch_threads_get will return a"]
#[doc = " valid object. Whereas when this function returns FALSE,"]
#[doc = " notmuch_threads_get will return NULL."]
#[doc = ""]
#[doc = " If passed a NULL pointer, this function returns FALSE"]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_threads for example"]
#[doc = " code showing how to iterate over a notmuch_threads_t object."]
pub fn notmuch_threads_valid(threads: *mut notmuch_threads_t) -> notmuch_bool_t;
}
extern "C" {
#[doc = " Get the current thread from 'threads' as a notmuch_thread_t."]
#[doc = ""]
#[doc = " Note: The returned thread belongs to 'threads' and has a lifetime"]
#[doc = " identical to it (and the query to which it belongs)."]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_threads for example"]
#[doc = " code showing how to iterate over a notmuch_threads_t object."]
#[doc = ""]
#[doc = " If an out-of-memory situation occurs, this function will return"]
#[doc = " NULL."]
pub fn notmuch_threads_get(threads: *mut notmuch_threads_t) -> *mut notmuch_thread_t;
}
extern "C" {
#[doc = " Move the 'threads' iterator to the next thread."]
#[doc = ""]
#[doc = " If 'threads' is already pointing at the last thread then the"]
#[doc = " iterator will be moved to a point just beyond that last thread,"]
#[doc = " (where notmuch_threads_valid will return FALSE and"]
#[doc = " notmuch_threads_get will return NULL)."]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_threads for example"]
#[doc = " code showing how to iterate over a notmuch_threads_t object."]
pub fn notmuch_threads_move_to_next(threads: *mut notmuch_threads_t);
}
extern "C" {
#[doc = " Destroy a notmuch_threads_t object."]
#[doc = ""]
#[doc = " It's not strictly necessary to call this function. All memory from"]
#[doc = " the notmuch_threads_t object will be reclaimed when the"]
#[doc = " containing query object is destroyed."]
pub fn notmuch_threads_destroy(threads: *mut notmuch_threads_t);
}
extern "C" {
#[doc = " Return the number of messages matching a search."]
#[doc = ""]
#[doc = " This function performs a search and returns the number of matching"]
#[doc = " messages."]
#[doc = ""]
#[doc = " @returns"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: query completed successfully."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The"]
#[doc = " value of *count is not defined."]
#[doc = ""]
#[doc = " @since libnotmuch 5 (notmuch 0.25)"]
pub fn notmuch_query_count_messages(
query: *mut notmuch_query_t,
count: *mut ::std::os::raw::c_uint,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Deprecated alias for notmuch_query_count_messages"]
#[doc = ""]
#[doc = ""]
#[doc = " @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please"]
#[doc = " use notmuch_query_count_messages instead."]
pub fn notmuch_query_count_messages_st(
query: *mut notmuch_query_t,
count: *mut ::std::os::raw::c_uint,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Return the number of threads matching a search."]
#[doc = ""]
#[doc = " This function performs a search and returns the number of unique thread IDs"]
#[doc = " in the matching messages. This is the same as number of threads matching a"]
#[doc = " search."]
#[doc = ""]
#[doc = " Note that this is a significantly heavier operation than"]
#[doc = " notmuch_query_count_messages{_st}()."]
#[doc = ""]
#[doc = " @returns"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value"]
#[doc = " of *count is not defined"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: query completed successfully."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The"]
#[doc = " value of *count is not defined."]
#[doc = ""]
#[doc = " @since libnotmuch 5 (notmuch 0.25)"]
pub fn notmuch_query_count_threads(
query: *mut notmuch_query_t,
count: *mut ::std::os::raw::c_uint,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Deprecated alias for notmuch_query_count_threads"]
#[doc = ""]
#[doc = " @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please"]
#[doc = " use notmuch_query_count_threads_st instead."]
pub fn notmuch_query_count_threads_st(
query: *mut notmuch_query_t,
count: *mut ::std::os::raw::c_uint,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Get the thread ID of 'thread'."]
#[doc = ""]
#[doc = " The returned string belongs to 'thread' and as such, should not be"]
#[doc = " modified by the caller and will only be valid for as long as the"]
#[doc = " thread is valid, (which is until notmuch_thread_destroy or until"]
#[doc = " the query from which it derived is destroyed)."]
pub fn notmuch_thread_get_thread_id(
thread: *mut notmuch_thread_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get the total number of messages in 'thread'."]
#[doc = ""]
#[doc = " This count consists of all messages in the database belonging to"]
#[doc = " this thread. Contrast with notmuch_thread_get_matched_messages() ."]
pub fn notmuch_thread_get_total_messages(
thread: *mut notmuch_thread_t,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " Get the total number of files in 'thread'."]
#[doc = ""]
#[doc = " This sums notmuch_message_count_files over all messages in the"]
#[doc = " thread"]
#[doc = " @returns Non-negative integer"]
#[doc = " @since libnotmuch 5.0 (notmuch 0.25)"]
pub fn notmuch_thread_get_total_files(thread: *mut notmuch_thread_t) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " Get a notmuch_messages_t iterator for the top-level messages in"]
#[doc = " 'thread' in oldest-first order."]
#[doc = ""]
#[doc = " This iterator will not necessarily iterate over all of the messages"]
#[doc = " in the thread. It will only iterate over the messages in the thread"]
#[doc = " which are not replies to other messages in the thread."]
#[doc = ""]
#[doc = " The returned list will be destroyed when the thread is destroyed."]
pub fn notmuch_thread_get_toplevel_messages(
thread: *mut notmuch_thread_t,
) -> *mut notmuch_messages_t;
}
extern "C" {
#[doc = " Get a notmuch_thread_t iterator for all messages in 'thread' in"]
#[doc = " oldest-first order."]
#[doc = ""]
#[doc = " The returned list will be destroyed when the thread is destroyed."]
pub fn notmuch_thread_get_messages(thread: *mut notmuch_thread_t) -> *mut notmuch_messages_t;
}
extern "C" {
#[doc = " Get the number of messages in 'thread' that matched the search."]
#[doc = ""]
#[doc = " This count includes only the messages in this thread that were"]
#[doc = " matched by the search from which the thread was created and were"]
#[doc = " not excluded by any exclude tags passed in with the query (see"]
#[doc = " notmuch_query_add_tag_exclude). Contrast with"]
#[doc = " notmuch_thread_get_total_messages() ."]
pub fn notmuch_thread_get_matched_messages(
thread: *mut notmuch_thread_t,
) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " Get the authors of 'thread' as a UTF-8 string."]
#[doc = ""]
#[doc = " The returned string is a comma-separated list of the names of the"]
#[doc = " authors of mail messages in the query results that belong to this"]
#[doc = " thread."]
#[doc = ""]
#[doc = " The string contains authors of messages matching the query first, then"]
#[doc = " non-matched authors (with the two groups separated by '|'). Within"]
#[doc = " each group, authors are ordered by date."]
#[doc = ""]
#[doc = " The returned string belongs to 'thread' and as such, should not be"]
#[doc = " modified by the caller and will only be valid for as long as the"]
#[doc = " thread is valid, (which is until notmuch_thread_destroy or until"]
#[doc = " the query from which it derived is destroyed)."]
pub fn notmuch_thread_get_authors(
thread: *mut notmuch_thread_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get the subject of 'thread' as a UTF-8 string."]
#[doc = ""]
#[doc = " The subject is taken from the first message (according to the query"]
#[doc = " order---see notmuch_query_set_sort) in the query results that"]
#[doc = " belongs to this thread."]
#[doc = ""]
#[doc = " The returned string belongs to 'thread' and as such, should not be"]
#[doc = " modified by the caller and will only be valid for as long as the"]
#[doc = " thread is valid, (which is until notmuch_thread_destroy or until"]
#[doc = " the query from which it derived is destroyed)."]
pub fn notmuch_thread_get_subject(
thread: *mut notmuch_thread_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get the date of the oldest message in 'thread' as a time_t value."]
pub fn notmuch_thread_get_oldest_date(thread: *mut notmuch_thread_t) -> time_t;
}
extern "C" {
#[doc = " Get the date of the newest message in 'thread' as a time_t value."]
pub fn notmuch_thread_get_newest_date(thread: *mut notmuch_thread_t) -> time_t;
}
extern "C" {
#[doc = " Get the tags for 'thread', returning a notmuch_tags_t object which"]
#[doc = " can be used to iterate over all tags."]
#[doc = ""]
#[doc = " Note: In the Notmuch database, tags are stored on individual"]
#[doc = " messages, not on threads. So the tags returned here will be all"]
#[doc = " tags of the messages which matched the search and which belong to"]
#[doc = " this thread."]
#[doc = ""]
#[doc = " The tags object is owned by the thread and as such, will only be"]
#[doc = " valid for as long as the thread is valid, (for example, until"]
#[doc = " notmuch_thread_destroy or until the query from which it derived is"]
#[doc = " destroyed)."]
#[doc = ""]
#[doc = " Typical usage might be:"]
#[doc = ""]
#[doc = " notmuch_thread_t *thread;"]
#[doc = " notmuch_tags_t *tags;"]
#[doc = " const char *tag;"]
#[doc = ""]
#[doc = " thread = notmuch_threads_get (threads);"]
#[doc = ""]
#[doc = " for (tags = notmuch_thread_get_tags (thread);"]
#[doc = " notmuch_tags_valid (tags);"]
#[doc = " notmuch_tags_move_to_next (tags))"]
#[doc = " {"]
#[doc = " tag = notmuch_tags_get (tags);"]
#[doc = " ...."]
#[doc = " }"]
#[doc = ""]
#[doc = " notmuch_thread_destroy (thread);"]
#[doc = ""]
#[doc = " Note that there's no explicit destructor needed for the"]
#[doc = " notmuch_tags_t object. (For consistency, we do provide a"]
#[doc = " notmuch_tags_destroy function, but there's no good reason to call"]
#[doc = " it if the message is about to be destroyed)."]
pub fn notmuch_thread_get_tags(thread: *mut notmuch_thread_t) -> *mut notmuch_tags_t;
}
extern "C" {
#[doc = " Destroy a notmuch_thread_t object."]
pub fn notmuch_thread_destroy(thread: *mut notmuch_thread_t);
}
extern "C" {
#[doc = " Is the given 'messages' iterator pointing at a valid message."]
#[doc = ""]
#[doc = " When this function returns TRUE, notmuch_messages_get will return a"]
#[doc = " valid object. Whereas when this function returns FALSE,"]
#[doc = " notmuch_messages_get will return NULL."]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_messages for example"]
#[doc = " code showing how to iterate over a notmuch_messages_t object."]
pub fn notmuch_messages_valid(messages: *mut notmuch_messages_t) -> notmuch_bool_t;
}
extern "C" {
#[doc = " Get the current message from 'messages' as a notmuch_message_t."]
#[doc = ""]
#[doc = " Note: The returned message belongs to 'messages' and has a lifetime"]
#[doc = " identical to it (and the query to which it belongs)."]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_messages for example"]
#[doc = " code showing how to iterate over a notmuch_messages_t object."]
#[doc = ""]
#[doc = " If an out-of-memory situation occurs, this function will return"]
#[doc = " NULL."]
pub fn notmuch_messages_get(messages: *mut notmuch_messages_t) -> *mut notmuch_message_t;
}
extern "C" {
#[doc = " Move the 'messages' iterator to the next message."]
#[doc = ""]
#[doc = " If 'messages' is already pointing at the last message then the"]
#[doc = " iterator will be moved to a point just beyond that last message,"]
#[doc = " (where notmuch_messages_valid will return FALSE and"]
#[doc = " notmuch_messages_get will return NULL)."]
#[doc = ""]
#[doc = " See the documentation of notmuch_query_search_messages for example"]
#[doc = " code showing how to iterate over a notmuch_messages_t object."]
pub fn notmuch_messages_move_to_next(messages: *mut notmuch_messages_t);
}
extern "C" {
#[doc = " Destroy a notmuch_messages_t object."]
#[doc = ""]
#[doc = " It's not strictly necessary to call this function. All memory from"]
#[doc = " the notmuch_messages_t object will be reclaimed when the containing"]
#[doc = " query object is destroyed."]
pub fn notmuch_messages_destroy(messages: *mut notmuch_messages_t);
}
extern "C" {
#[doc = " Return a list of tags from all messages."]
#[doc = ""]
#[doc = " The resulting list is guaranteed not to contain duplicated tags."]
#[doc = ""]
#[doc = " WARNING: You can no longer iterate over messages after calling this"]
#[doc = " function, because the iterator will point at the end of the list."]
#[doc = " We do not have a function to reset the iterator yet and the only"]
#[doc = " way how you can iterate over the list again is to recreate the"]
#[doc = " message list."]
#[doc = ""]
#[doc = " The function returns NULL on error."]
pub fn notmuch_messages_collect_tags(messages: *mut notmuch_messages_t) -> *mut notmuch_tags_t;
}
extern "C" {
#[doc = " Get the database associated with this message."]
#[doc = ""]
#[doc = " @since libnotmuch 5.2 (notmuch 0.27)"]
pub fn notmuch_message_get_database(
message: *const notmuch_message_t,
) -> *mut notmuch_database_t;
}
extern "C" {
#[doc = " Get the message ID of 'message'."]
#[doc = ""]
#[doc = " The returned string belongs to 'message' and as such, should not be"]
#[doc = " modified by the caller and will only be valid for as long as the"]
#[doc = " message is valid, (which is until the query from which it derived"]
#[doc = " is destroyed)."]
#[doc = ""]
#[doc = " This function will not return NULL since Notmuch ensures that every"]
#[doc = " message has a unique message ID, (Notmuch will generate an ID for a"]
#[doc = " message if the original file does not contain one)."]
pub fn notmuch_message_get_message_id(
message: *mut notmuch_message_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get the thread ID of 'message'."]
#[doc = ""]
#[doc = " The returned string belongs to 'message' and as such, should not be"]
#[doc = " modified by the caller and will only be valid for as long as the"]
#[doc = " message is valid, (for example, until the user calls"]
#[doc = " notmuch_message_destroy on 'message' or until a query from which it"]
#[doc = " derived is destroyed)."]
#[doc = ""]
#[doc = " This function will not return NULL since Notmuch ensures that every"]
#[doc = " message belongs to a single thread."]
pub fn notmuch_message_get_thread_id(
message: *mut notmuch_message_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get a notmuch_messages_t iterator for all of the replies to"]
#[doc = " 'message'."]
#[doc = ""]
#[doc = " Note: This call only makes sense if 'message' was ultimately"]
#[doc = " obtained from a notmuch_thread_t object, (such as by coming"]
#[doc = " directly from the result of calling notmuch_thread_get_"]
#[doc = " toplevel_messages or by any number of subsequent"]
#[doc = " calls to notmuch_message_get_replies)."]
#[doc = ""]
#[doc = " If 'message' was obtained through some non-thread means, (such as"]
#[doc = " by a call to notmuch_query_search_messages), then this function"]
#[doc = " will return NULL."]
#[doc = ""]
#[doc = " If there are no replies to 'message', this function will return"]
#[doc = " NULL. (Note that notmuch_messages_valid will accept that NULL"]
#[doc = " value as legitimate, and simply return FALSE for it.)"]
#[doc = ""]
#[doc = " The returned list will be destroyed when the thread is destroyed."]
pub fn notmuch_message_get_replies(message: *mut notmuch_message_t) -> *mut notmuch_messages_t;
}
extern "C" {
#[doc = " Get the total number of files associated with a message."]
#[doc = " @returns Non-negative integer"]
#[doc = " @since libnotmuch 5.0 (notmuch 0.25)"]
pub fn notmuch_message_count_files(message: *mut notmuch_message_t) -> ::std::os::raw::c_int;
}
extern "C" {
#[doc = " Get a filename for the email corresponding to 'message'."]
#[doc = ""]
#[doc = " The returned filename is an absolute filename, (the initial"]
#[doc = " component will match notmuch_database_get_path() )."]
#[doc = ""]
#[doc = " The returned string belongs to the message so should not be"]
#[doc = " modified or freed by the caller (nor should it be referenced after"]
#[doc = " the message is destroyed)."]
#[doc = ""]
#[doc = " Note: If this message corresponds to multiple files in the mail"]
#[doc = " store, (that is, multiple files contain identical message IDs),"]
#[doc = " this function will arbitrarily return a single one of those"]
#[doc = " filenames. See notmuch_message_get_filenames for returning the"]
#[doc = " complete list of filenames."]
pub fn notmuch_message_get_filename(
message: *mut notmuch_message_t,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get all filenames for the email corresponding to 'message'."]
#[doc = ""]
#[doc = " Returns a notmuch_filenames_t iterator listing all the filenames"]
#[doc = " associated with 'message'. These files may not have identical"]
#[doc = " content, but each will have the identical Message-ID."]
#[doc = ""]
#[doc = " Each filename in the iterator is an absolute filename, (the initial"]
#[doc = " component will match notmuch_database_get_path() )."]
pub fn notmuch_message_get_filenames(
message: *mut notmuch_message_t,
) -> *mut notmuch_filenames_t;
}
extern "C" {
#[doc = " Re-index the e-mail corresponding to 'message' using the supplied index options"]
#[doc = ""]
#[doc = " Returns the status of the re-index operation. (see the return"]
#[doc = " codes documented in notmuch_database_index_file)"]
#[doc = ""]
#[doc = " After reindexing, the user should discard the message object passed"]
#[doc = " in here by calling notmuch_message_destroy, since it refers to the"]
#[doc = " original message, not to the reindexed message."]
pub fn notmuch_message_reindex(
message: *mut notmuch_message_t,
indexopts: *mut notmuch_indexopts_t,
) -> notmuch_status_t;
}
pub const _notmuch_message_flag_NOTMUCH_MESSAGE_FLAG_MATCH: _notmuch_message_flag = 0;
pub const _notmuch_message_flag_NOTMUCH_MESSAGE_FLAG_EXCLUDED: _notmuch_message_flag = 1;
pub const _notmuch_message_flag_NOTMUCH_MESSAGE_FLAG_GHOST: _notmuch_message_flag = 2;
#[doc = " Message flags."]
pub type _notmuch_message_flag = u32;
pub use self::_notmuch_message_flag as notmuch_message_flag_t;
extern "C" {
#[doc = " Get a value of a flag for the email corresponding to 'message'."]
pub fn notmuch_message_get_flag(
message: *mut notmuch_message_t,
flag: notmuch_message_flag_t,
) -> notmuch_bool_t;
}
extern "C" {
#[doc = " Set a value of a flag for the email corresponding to 'message'."]
pub fn notmuch_message_set_flag(
message: *mut notmuch_message_t,
flag: notmuch_message_flag_t,
value: notmuch_bool_t,
);
}
extern "C" {
#[doc = " Get the date of 'message' as a time_t value."]
#[doc = ""]
#[doc = " For the original textual representation of the Date header from the"]
#[doc = " message call notmuch_message_get_header() with a header value of"]
#[doc = " \"date\"."]
pub fn notmuch_message_get_date(message: *mut notmuch_message_t) -> time_t;
}
extern "C" {
#[doc = " Get the value of the specified header from 'message' as a UTF-8 string."]
#[doc = ""]
#[doc = " Common headers are stored in the database when the message is"]
#[doc = " indexed and will be returned from the database. Other headers will"]
#[doc = " be read from the actual message file."]
#[doc = ""]
#[doc = " The header name is case insensitive."]
#[doc = ""]
#[doc = " The returned string belongs to the message so should not be"]
#[doc = " modified or freed by the caller (nor should it be referenced after"]
#[doc = " the message is destroyed)."]
#[doc = ""]
#[doc = " Returns an empty string (\"\") if the message does not contain a"]
#[doc = " header line matching 'header'. Returns NULL if any error occurs."]
pub fn notmuch_message_get_header(
message: *mut notmuch_message_t,
header: *const ::std::os::raw::c_char,
) -> *const ::std::os::raw::c_char;
}
extern "C" {
#[doc = " Get the tags for 'message', returning a notmuch_tags_t object which"]
#[doc = " can be used to iterate over all tags."]
#[doc = ""]
#[doc = " The tags object is owned by the message and as such, will only be"]
#[doc = " valid for as long as the message is valid, (which is until the"]
#[doc = " query from which it derived is destroyed)."]
#[doc = ""]
#[doc = " Typical usage might be:"]
#[doc = ""]
#[doc = " notmuch_message_t *message;"]
#[doc = " notmuch_tags_t *tags;"]
#[doc = " const char *tag;"]
#[doc = ""]
#[doc = " message = notmuch_database_find_message (database, message_id);"]
#[doc = ""]
#[doc = " for (tags = notmuch_message_get_tags (message);"]
#[doc = " notmuch_tags_valid (tags);"]
#[doc = " notmuch_tags_move_to_next (tags))"]
#[doc = " {"]
#[doc = " tag = notmuch_tags_get (tags);"]
#[doc = " ...."]
#[doc = " }"]
#[doc = ""]
#[doc = " notmuch_message_destroy (message);"]
#[doc = ""]
#[doc = " Note that there's no explicit destructor needed for the"]
#[doc = " notmuch_tags_t object. (For consistency, we do provide a"]
#[doc = " notmuch_tags_destroy function, but there's no good reason to call"]
#[doc = " it if the message is about to be destroyed)."]
pub fn notmuch_message_get_tags(message: *mut notmuch_message_t) -> *mut notmuch_tags_t;
}
extern "C" {
#[doc = " Add a tag to the given message."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Tag successfully added to message"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long"]
#[doc = "\t(exceeds NOTMUCH_TAG_MAX)"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only"]
#[doc = "\tmode so message cannot be modified."]
pub fn notmuch_message_add_tag(
message: *mut notmuch_message_t,
tag: *const ::std::os::raw::c_char,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Remove a tag from the given message."]
#[doc = ""]
#[doc = " Return value:"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long"]
#[doc = "\t(exceeds NOTMUCH_TAG_MAX)"]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only"]
#[doc = "\tmode so message cannot be modified."]
pub fn notmuch_message_remove_tag(
message: *mut notmuch_message_t,
tag: *const ::std::os::raw::c_char,
) -> notmuch_status_t;
}
extern "C" {
#[doc = " Remove all tags from the given message."]
#[doc = ""]
#[doc = " See notmuch_message_freeze for an example showing how to safely"]
#[doc = " replace tag values."]
#[doc = ""]
#[doc = " NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only"]
#[doc = "\tmode so message cannot be modified."]
pub fn notmuch_message_remove_all_tags(message: *mut notmuch_message_t) -> notmuch_status_t;
}
extern "C" {
#[doc = " Add/remove tags according to maildir flags in the message filename(s)."]
#[doc = ""]
#[doc = " This function examines the filenames of 'message' for maildir"]
#[doc = " flags, and adds or removes tags on 'message' as follows when these"]
#[doc = " flags are present:"]
#[doc = ""]
#[doc = "\tFlag\tAction if present"]
#[doc = "\t----\t-----------------"]
#[doc = "\t'D'\tAdds the \"draft\" tag to the message"]
#[doc = "\t'F'\tAdds the \"flagged\" tag to the message"]
#[doc = "\t'P'\tAdds the \"passed\" tag to the message"]
#[doc = "\t'R'\tAdds the \"replied\" tag to the message"]
#[doc = "\t'S'\tRemoves the \"unread\" tag from the message"]
#[doc = ""]
#[doc = " For each flag that is not present, the opposite action (add/remove)"]
#[doc = " is performed for the corresponding tags."]
#[doc = ""]
#[doc = " Flags are identified as trailing components of the filename after a"]
#[doc = " sequence of \":2,\"."]
#[doc = ""]
#[doc = " If there are multiple filenames associated with this message, the"]
#[doc = " flag is considered present if it appears in one or more"]