meli
/
meli
8
Fork 13
Code Issues 10 Pull Requests 10 Actions Packages Projects 1 Releases 18 Wiki Activity

melib/notmuch: add some doc comments 

Signed-off-by: Manos Pitsidianakis <manos@pitsidianak.is>
pull/329/head
Manos Pitsidianakis 2023-12-17 19:13:15 +02:00
parent ca7d7bb95d
commit 4026e25428
Signed by: Manos Pitsidianakis
GPG Key ID: 7729C7707F7E09D0
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
melib/src/notmuch/message.rs
View File

@ -212,6 +212,7 @@ impl<'m> Message<'m> {
)
}
#[doc(alias = "notmuch_message_add_tag")]
pub fn add_tag(&self, tag: &CStr) -> Result<()> {
if let Err(err) = unsafe {
try_call!(
@ -224,6 +225,7 @@ impl<'m> Message<'m> {
Ok(())
}
#[doc(alias = "notmuch_message_remove_tag")]
pub fn remove_tag(&self, tag: &CStr) -> Result<()> {
if let Err(err) = unsafe {
try_call!(
@ -240,6 +242,7 @@ impl<'m> Message<'m> {
TagIterator::new(self)
}
#[doc(alias = "notmuch_message_tags_to_maildir_flags")]
pub fn tags_to_maildir_flags(&self) -> Result<()> {
if let Err(err) = unsafe {
try_call!(
@ -252,6 +255,23 @@ impl<'m> Message<'m> {
Ok(())
}
/// Get a filename for the email corresponding to 'message'.
///
/// Quoted from `libnotmuch` C header:
///
/// > The returned filename is an absolute filename, (the initial
/// > component will match `notmuch_database_get_path()`).
/// >
/// > The returned string belongs to the message so should not be
/// > modified or freed by the caller (nor should it be referenced after
/// > the message is destroyed).
/// >
/// > Note: If this message corresponds to multiple files in the mail
/// > store, (that is, multiple files contain identical message IDs),
/// > this function will arbitrarily return a single one of those
/// > filenames. See `notmuch_message_get_filenames` for returning the
/// > complete list of filenames.
#[doc(alias = "notmuch_message_get_filename")]
pub fn get_filename(&self) -> &OsStr {
let fs_path =
unsafe { call!(self.lib, notmuch_message_get_filename)(self.message.as_ptr()) };