Add missing chatlist documentation

This commit is contained in:
link2xt
2023-01-24 10:11:38 +00:00
parent d522b7ef1e
commit c349a5c75b

View File

@@ -1,7 +1,5 @@
//! # Chat list module. //! # Chat list module.
#![allow(missing_docs)]
use anyhow::{ensure, Context as _, Result}; use anyhow::{ensure, Context as _, Result};
use crate::chat::{update_special_chat_names, Chat, ChatId, ChatVisibility}; use crate::chat::{update_special_chat_names, Chat, ChatId, ChatVisibility};
@@ -341,10 +339,12 @@ impl Chatlist {
} }
} }
/// Returns chatlist item position for the given chat ID.
pub fn get_index_for_id(&self, id: ChatId) -> Option<usize> { pub fn get_index_for_id(&self, id: ChatId) -> Option<usize> {
self.ids.iter().position(|(chat_id, _)| chat_id == &id) self.ids.iter().position(|(chat_id, _)| chat_id == &id)
} }
/// An iterator visiting all chatlist items.
pub fn iter(&self) -> impl Iterator<Item = &(ChatId, Option<MsgId>)> { pub fn iter(&self) -> impl Iterator<Item = &(ChatId, Option<MsgId>)> {
self.ids.iter() self.ids.iter()
} }