Adds "unstable-exhaustive-types" as new feature.

This feature deactivates all "#[non_exhaustive]" added into the code. This can be used by developers to ensure, that they match all enum variants or struct fields during pattern matching.

Author: TheCataliasTNT2k

Cargo.toml

@@ -153,6 +153,10 @@ native_tls_backend = [
     "bytes",
 ]
 
+# Disables all "#[non_exhaustive]" macros, to ensure that all enum variants or struct fields are required when pattern matching.
+unstable_exhaustive_types = ["serenity-voice-model/unstable_exhaustive_types"]
+
+
 
 [package.metadata.docs.rs]
 features = ["full"]

src/builder/create_attachment.rs

@@ -17,7 +17,7 @@ use crate::model::id::AttachmentId;
 ///
 /// [Discord docs](https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure).
 #[derive(Clone, Debug, Serialize, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 #[must_use]
 pub struct CreateAttachment {
     pub(crate) id: u64, // Placeholder ID will be filled in when sending the request

src/cache/mod.rs

@@ -152,7 +152,7 @@ pub(crate) struct CachedShardData {
 /// [`http`]: crate::http
 #[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
 #[derive(Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub struct Cache {
     // Temp cache:
     // ---

src/cache/settings.rs

@@ -14,7 +14,7 @@ use std::time::Duration;
 /// ```
 #[cfg_attr(feature = "typesize", derive(typesize::derive::TypeSize))]
 #[derive(Clone, Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub struct Settings {
     /// The maximum number of messages to store in a channel's message cache.
     ///

src/client/error.rs

@@ -8,7 +8,7 @@ use std::fmt;
 /// [`Client`]: super::Client
 /// [`Error::Client`]: crate::Error::Client
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub enum Error {
     /// When a shard has completely failed to reboot after resume and/or reconnect attempts.
     ShardBootFailure,

src/client/event_handler.rs

@@ -27,7 +27,7 @@ macro_rules! event_handler {
         }
 
         /// This enum stores every possible event that an [`EventHandler`] can receive.
-        #[non_exhaustive]
+        #[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
         #[allow(clippy::large_enum_variant)] // TODO: do some boxing to fix this
         #[derive(Clone, Debug)]
         pub enum FullEvent {

src/constants.rs

@@ -35,8 +35,7 @@ enum_number! {
     ///
     /// [Discord docs](https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes).
     #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Deserialize, Serialize)]
-    #[serde(from = "u8", into = "u8")]
-    #[non_exhaustive]
+    #[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
     pub enum Opcode {
         /// Dispatches an event.
         Dispatch = 0,

src/error.rs

@@ -30,7 +30,7 @@ pub type Result<T, E = Error> = StdResult<T, E>;
 /// The most common error types, the [`ClientError`] and [`GatewayError`] enums, are both wrapped
 /// around this in the form of the [`Self::Client`] and [`Self::Gateway`] variants.
 #[derive(Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub enum Error {
     /// An error while decoding a payload.
     Decode(&'static str, Value),

src/framework/standard/args.rs

@@ -8,7 +8,7 @@ use uwl::Stream;
 
 /// Defines how an operation on an [`Args`] method failed.
 #[derive(Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub enum Error<E> {
     /// "END-OF-STRING". We reached the end. There's nothing to parse anymore.
     Eos,

src/framework/standard/help_commands.rs

@@ -120,7 +120,7 @@ pub struct SuggestedCommandName {
 
 /// A single command containing all related pieces of information.
 #[derive(Clone, Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub struct Command<'a> {
     pub name: &'static str,
     pub group_name: &'static str,
@@ -172,7 +172,7 @@ impl Suggestions {
 /// Covers possible outcomes of a help-request and yields relevant data in customised textual
 /// representation.
 #[derive(Clone, Debug)]
-#[non_exhaustive]
+#[cfg_attr(any(not(feature = "unstable_exhaustive_types"), doc), non_exhaustive)]
 pub enum CustomisedHelpData<'a> {
     /// To display suggested commands.
     SuggestedCommands { help_description: String, suggestions: Suggestions },