From c1856ff6ce67b84a4a1d8e98df1570e9744079f2 Mon Sep 17 00:00:00 2001 From: P0lunin Date: Wed, 23 Oct 2019 19:21:48 +0300 Subject: [PATCH] added docs --- .../dispatchers/filter/filters/message_caption.rs | 13 +++++++++++++ .../dispatchers/filter/filters/message_text.rs | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/src/dispatching/dispatchers/filter/filters/message_caption.rs b/src/dispatching/dispatchers/filter/filters/message_caption.rs index f68d0837..ccb956f1 100644 --- a/src/dispatching/dispatchers/filter/filters/message_caption.rs +++ b/src/dispatching/dispatchers/filter/filters/message_caption.rs @@ -1,6 +1,19 @@ use crate::dispatching::Filter; use crate::types::Message; +/// Filter which compare caption of media with another text. +/// Returns true if the caption of media is equal to another text, otherwise false. +/// +/// NOTE: filter compares only caption of media, does not compare text of message! +/// +/// If you want to compare text of message use +/// [MessageTextFilter] +/// +/// If you want to compare text and caption use +/// [MessageTextCaptionFilter] +/// +/// [MessageTextFilter]: telebofr::dispatching::dispatchers::filter::filters::MessageTextFilter +/// [MessageTextCaptionFilter]: telebofr::dispatching::dispatchers::filter::filters::MessageTextCaptionFilter pub struct MessageCaptionFilter { text: String, } diff --git a/src/dispatching/dispatchers/filter/filters/message_text.rs b/src/dispatching/dispatchers/filter/filters/message_text.rs index 765c149e..01da11af 100644 --- a/src/dispatching/dispatchers/filter/filters/message_text.rs +++ b/src/dispatching/dispatchers/filter/filters/message_text.rs @@ -1,6 +1,19 @@ use crate::dispatching::Filter; use crate::types::Message; +/// Filter which compare message text with another text. +/// Returns true if the message text is equal to another text, otherwise false. +/// +/// NOTE: filter compares only text message, does not compare caption of media! +/// +/// If you want to compare caption use +/// [MessageCaptionFilter] +/// +/// If you want to compare text and caption use +/// [MessageTextCaptionFilter] +/// +/// [MessageCaptionFilter]: telebofr::dispatching::dispatchers::filter::filters::MessageCaptionFilter +/// [MessageTextCaptionFilter]: telebofr::dispatching::dispatchers::filter::filters::MessageTextCaptionFilter pub struct MessageTextFilter { text: String, }