From 57e783e8a3af7152bbdac7473171a125cbbf6b48 Mon Sep 17 00:00:00 2001 From: Antoine Martin Date: Tue, 2 Feb 2021 07:37:48 +0100 Subject: [PATCH] bot: comments --- src/bot.rs | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/bot.rs b/src/bot.rs index ddcb44b..b4cbfb8 100644 --- a/src/bot.rs +++ b/src/bot.rs @@ -14,6 +14,10 @@ pub struct BadNewsBot { } impl BadNewsBot { + /// Creates a new [`BadNewsBot`] and builds a [`matrix_sdk::Client`] using the provided + /// [`Config`]. + /// + /// The [`Client`] is only initialized, not ready to be used yet. pub fn new(config: Config) -> anyhow::Result { let client_config = ClientConfig::new().store_path(config.state_dir.join("store")); let client = Client::new_with_config(config.homeserver.clone(), client_config)?; @@ -21,6 +25,9 @@ impl BadNewsBot { Ok(Self { client, config }) } + /// Loads session information from file, or creates it if no previous session is found. + /// + /// The bot is ready to run once this function has been called. pub async fn init(&self) -> anyhow::Result<()> { load_or_init_session(&self).await?; @@ -31,21 +38,26 @@ impl BadNewsBot { Ok(()) } + /// Start listening to Matrix events. + /// + /// [`BadNewsBot::init`] **must** be called before this function, otherwise the [`Client`] isn't + /// logged in. pub async fn run(&self) { self.client.sync(SyncSettings::default()).await } } +/// This loads the session information from an existing file, and tries to login with it. If no such +/// file is found, then login using username and password, and save the new session information on +/// disk. async fn load_or_init_session(bot: &BadNewsBot) -> anyhow::Result<()> { let session_file = bot.config.state_dir.join("session.yaml"); if session_file.is_file() { let reader = BufReader::new(File::open(session_file)?); - let session: Session = serde_yaml::from_reader(reader)?; bot.client.restore_login(session.clone()).await?; - println!("Reused session: {}, {}", session.user_id, session.device_id); } else { let response = bot