Improve function documentation

This commit is contained in:
jikstra
2019-08-05 12:10:22 +02:00
committed by Floris Bruynooghe
parent 10689f45f4
commit c0b1e41820

View File

@@ -803,8 +803,19 @@ pub unsafe fn dc_create_outgoing_rfc724_mid(
ret
}
/// Extract our group ID from Message-IDs as `Gr.12345678901.morerandom@domain.de`
/// `12345678901` is the wanted ID in this example.
/// Extract the group id (grpid) from a message id (mid)
///
/// # Arguments
///
/// * `mid` - A string that holds the message id
///
/// # Examples
///
/// ```
/// let mid = "Gr.12345678901.morerandom@domain.de";
/// let grpid = dc_extract_grpid_from_rfc724_mid(mid);
/// assert_eq!(grpid, Some("12345678901"));
/// ```
pub fn dc_extract_grpid_from_rfc724_mid(mid: &str) -> Option<&str> {
if mid.len() < 9 || !mid.starts_with("Gr.") {
return None;