RUST-765 Ensure public structs are future proof (C-STRUCT-PRIVATE)

Author: patrickfreed

src/de/error.rs

@@ -17,6 +17,7 @@ pub enum Error {
 
     /// While decoding a `Document` from bytes, an unexpected or unsupported element type was
     /// encountered.
+    #[non_exhaustive]
     UnrecognizedDocumentElementType {
         /// The key at which an unexpected/unsupported element type was encountered.
         key: String,
@@ -26,12 +27,14 @@ pub enum Error {
     },
 
     /// There was an error with the syntactical structure of the BSON.
+    #[non_exhaustive]
     SyntaxError { message: String },
 
     /// The end of the BSON input was reached too soon.
     EndOfStream,
 
     /// An invalid datetime was encountered while decoding.
+    #[non_exhaustive]
     InvalidDateTime {
         /// The key at which an unexpected/unsupported datetime was encountered.
         key: String,
@@ -42,6 +45,7 @@ pub enum Error {
 
     /// A general error encountered during deserialization.
     /// See: https://docs.serde.rs/serde/de/trait.Error.html
+    #[non_exhaustive]
     DeserializationError {
         /// A message describing the error.
         message: String,

src/de/serde.rs

@@ -23,7 +23,7 @@ use crate::{
     spec::BinarySubtype,
 };
 
-pub struct BsonVisitor;
+pub(crate) struct BsonVisitor;
 
 impl<'de> Deserialize<'de> for ObjectId {
     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

src/ser/error.rs

@@ -12,16 +12,14 @@ pub enum Error {
     IoError(Arc<io::Error>),
 
     /// A key could not be serialized to a BSON string.
-    InvalidMapKeyType {
-        /// The value that could not be used as a key.
-        key: Bson,
-    },
+    InvalidDocumentKey(Bson),
 
     /// Attempted to serialize a sub-millisecond precision datetime, which BSON does not support.
     SubMillisecondPrecisionDateTime(crate::DateTime),
 
     /// A general error that ocurred during serialization.
     /// See: https://docs.rs/serde/1.0.110/serde/ser/trait.Error.html#tymethod.custom
+    #[non_exhaustive]
     SerializationError {
         /// A message describing the error.
         message: String,
@@ -50,7 +48,7 @@ impl fmt::Display for Error {
     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
         match *self {
             Error::IoError(ref inner) => inner.fmt(fmt),
-            Error::InvalidMapKeyType { ref key } => write!(fmt, "Invalid map key type: {}", key),
+            Error::InvalidDocumentKey(ref key) => write!(fmt, "Invalid map key type: {}", key),
             Error::SerializationError { ref message } => message.fmt(fmt),
             #[cfg(not(feature = "u2i"))]
             Error::UnsupportedUnsignedInteger(value) => write!(

src/ser/serde.rs

@@ -84,6 +84,7 @@ impl Serialize for Bson {
 }
 
 /// Serde Serializer
+#[non_exhaustive]
 pub struct Serializer;
 
 impl Serializer {
@@ -440,7 +441,7 @@ impl SerializeMap for MapSerializer {
     fn serialize_key<T: ?Sized + Serialize>(&mut self, key: &T) -> crate::ser::Result<()> {
         self.next_key = match to_bson(&key)? {
             Bson::String(s) => Some(s),
-            other => return Err(Error::InvalidMapKeyType { key: other }),
+            other => return Err(Error::InvalidDocumentKey(other)),
         };
         Ok(())
     }