Fix clippy warnings/MSRV on current (#3371)

Author: GnomedDev

.github/workflows/ci.yml

@@ -166,6 +166,7 @@ jobs:
         run: |
           cargo update idna_adapter --precise 1.1.0
           cargo update triomphe --precise 0.1.11
+          cargo update base64ct --precise 1.7.3
 
       - name: Check
         run: cargo check --features full

src/client/mod.rs

@@ -665,6 +665,10 @@ impl Client {
     /// # }
     /// ```
     ///
+    /// # Errors
+    ///
+    /// Returns a [`ClientError::Shutdown`] when all shards have shutdown due to an error.
+    ///
     /// [gateway docs]: crate::gateway#sharding
     #[instrument(skip(self))]
     pub async fn start(&mut self) -> Result<()> {

src/framework/standard/parse/mod.rs

@@ -30,7 +30,7 @@ fn permissions_in(
     roles: &HashMap<RoleId, Role>,
 ) -> Permissions {
     let guild = ctx.cache.guild(guild_id);
-    if guild.as_ref().map(|guild| member.user.id == guild.owner_id) == Some(true) {
+    if guild.as_ref().is_some_and(|guild| member.user.id == guild.owner_id) {
         return Permissions::all();
     }
 

src/gateway/bridge/shard_manager.rs

@@ -182,6 +182,7 @@ impl ShardManager {
     /// This will communicate shard boots with the [`ShardQueuer`] so that they are properly
     /// queued.
     #[instrument(skip(self))]
+    #[allow(clippy::missing_errors_doc)] // Doesn't actually error, fixed on next.
     pub fn initialize(&self) -> Result<()> {
         let shard_index = self.shard_index.load(Ordering::Relaxed);
         let shard_init = self.shard_init.load(Ordering::Relaxed);

src/gateway/bridge/shard_runner.rs

@@ -93,6 +93,10 @@ impl ShardRunner {
     ///
     /// 6. Go back to 1.
     ///
+    /// # Errors
+    ///
+    /// Returns an error if authentication fails or the intents contained disallowed values.
+    ///
     /// [`ShardManager`]: super::ShardManager
     #[instrument(skip(self))]
     pub async fn run(&mut self) -> Result<()> {

src/gateway/shard.rs

@@ -630,6 +630,9 @@ impl Shard {
     /// # }
     /// ```
     ///
+    /// # Errors
+    /// Errors if there is a problem with the WS connection.
+    ///
     /// [`Event::GuildMembersChunk`]: crate::model::event::Event::GuildMembersChunk
     /// [`Guild`]: crate::model::guild::Guild
     /// [`Member`]: crate::model::guild::Member
@@ -650,6 +653,9 @@ impl Shard {
     /// Sets the shard as going into identifying stage, which sets:
     /// - the time that the last heartbeat sent as being now
     /// - the `stage` to [`ConnectionStage::Identifying`]
+    ///
+    /// # Errors
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self))]
     pub async fn identify(&mut self) -> Result<()> {
         self.client.send_identify(&self.info, &self.token, self.intents, &self.presence).await?;
@@ -663,6 +669,10 @@ impl Shard {
     /// Initializes a new WebSocket client.
     ///
     /// This will set the stage of the shard before and after instantiation of the client.
+    ///
+    /// # Errors
+    ///
+    /// Errors if unable to establish a websocket connection.
     #[instrument(skip(self))]
     pub async fn initialize(&mut self) -> Result<WsClient> {
         debug!("[{:?}] Initializing.", self.info);
@@ -694,6 +704,9 @@ impl Shard {
         self.seq = 0;
     }
 
+    /// # Errors
+    ///
+    /// Errors if unable to re-establish a websocket connection.
     #[instrument(skip(self))]
     pub async fn resume(&mut self) -> Result<()> {
         debug!("[{:?}] Attempting to resume", self.info);
@@ -709,6 +722,9 @@ impl Shard {
         }
     }
 
+    /// # Errors
+    ///
+    /// Errors if unable to re-establish a websocket connection.
     #[instrument(skip(self))]
     pub async fn reconnect(&mut self) -> Result<()> {
         info!("[{:?}] Attempting to reconnect", self.shard_info());
@@ -719,6 +735,9 @@ impl Shard {
         Ok(())
     }
 
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self))]
     pub async fn update_presence(&mut self) -> Result<()> {
         self.client.send_presence_update(&self.info, &self.presence).await

src/gateway/ws.rs

@@ -180,7 +180,9 @@ impl WsClient {
         Ok(())
     }
 
-    #[allow(clippy::missing_errors_doc)]
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     pub async fn send_chunk_guild(
         &mut self,
         guild_id: GuildId,
@@ -212,6 +214,9 @@ impl WsClient {
         .await
     }
 
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self))]
     pub async fn send_heartbeat(&mut self, shard_info: &ShardInfo, seq: Option<u64>) -> Result<()> {
         trace!("[{:?}] Sending heartbeat d: {:?}", shard_info, seq);
@@ -223,6 +228,9 @@ impl WsClient {
         .await
     }
 
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self, token))]
     pub async fn send_identify(
         &mut self,
@@ -261,6 +269,9 @@ impl WsClient {
         self.send_json(&msg).await
     }
 
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self))]
     pub async fn send_presence_update(
         &mut self,
@@ -284,6 +295,9 @@ impl WsClient {
         .await
     }
 
+    /// # Errors
+    ///
+    /// Errors if there is a problem with the WS connection.
     #[instrument(skip(self, token))]
     pub async fn send_resume(
         &mut self,

src/http/ratelimiting.rs

@@ -323,6 +323,9 @@ impl Ratelimit {
         self.remaining -= 1;
     }
 
+    /// # Errors
+    ///
+    /// Errors if parsing headers from the response fails.
     #[instrument(skip(ratelimit_callback))]
     pub async fn post_hook(
         &mut self,

src/http/request.rs

@@ -63,6 +63,7 @@ impl<'a> Request<'a> {
         self
     }
 
+    #[allow(clippy::missing_errors_doc)]
     #[instrument(skip(token))]
     pub fn build(
         self,