Prepare flatdata release: Fix latest warnings, bump version (#241)

Signed-off-by: Christian Vetter <[email protected]>

flatdata-rs/lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flatdata"
-version = "0.5.4"
+version = "0.5.5"
 authors = ["boxdot <[email protected]>", "Christian Vetter <[email protected]>", "Gabriel Féron <[email protected]>"]
 license = "Apache-2.0"
 description = "Rust implementation of flatdata"

flatdata-rs/lib/src/error.rs

@@ -5,6 +5,7 @@ use std::{error, fmt, io, str::Utf8Error};
 ///
 /// [`Storage`]: trait.Storage.html
 #[derive(Debug)]
+#[non_exhaustive]
 pub enum ResourceStorageError {
     /// Wrapper of [`io::Error`] with resource name for which the error
     /// occurred.
@@ -44,8 +45,6 @@ pub enum ResourceStorageError {
     },
     /// A resource / archive is missing completely
     Missing,
-    #[doc(hidden)]
-    __Nonexhaustive,
 }
 
 impl ResourceStorageError {
@@ -74,7 +73,6 @@ impl error::Error for ResourceStorageError {
             ResourceStorageError::WrongSignature { .. } => "schema is not matching expected schema",
             ResourceStorageError::TooBig { .. } => "resource is too big",
             ResourceStorageError::Missing => "Missing resource / archive",
-            ResourceStorageError::__Nonexhaustive => "n/a",
         }
     }
 }

flatdata-rs/lib/src/filestorage.rs

@@ -28,7 +28,7 @@ impl MemoryMappedFileStorage {
         // We cannot prove to Rust that the buffer will live as long as the storage
         // (we never delete mappings), so we need to manually extend lifetime
         let extended_lifetime_data = unsafe { slice::from_raw_parts(data.as_ptr(), data.len()) };
-        Ok(&extended_lifetime_data)
+        Ok(extended_lifetime_data)
     }
 }
 

flatdata-rs/lib/src/generator.rs

@@ -59,9 +59,9 @@ use std::{
 /// If you are working on the generator, you can make sure your `build.rs`
 /// script picks up the source by setting `FLATDATA_GENERATOR_PATH` to point to
 /// the `flatdata-generator` folder.
-/// 
+///
 /// ## Build
-/// 
+///
 /// This method will try to install flatdata-generator in a python venv automatically
 /// You can provide your own generator by setting `FLATDATA_GENERATOR_BIN` to point to
 /// the `flatdata-generator` binary.
@@ -108,15 +108,15 @@ pub fn generate(
         out_dir.join("bin/flatdata-generator")
     };
 
-    for entry in walkdir::WalkDir::new(&schemas_path) {
+    for entry in walkdir::WalkDir::new(schemas_path) {
         let entry = entry?;
         if entry.path().extension().map_or(true, |x| x != "flatdata") {
             continue;
         }
 
         let result: PathBuf = if schemas_path.is_dir() {
             out_dir
-                .join(entry.path().strip_prefix(&schemas_path).unwrap())
+                .join(entry.path().strip_prefix(schemas_path).unwrap())
                 .with_extension("rs")
         } else {
             out_dir
@@ -134,7 +134,7 @@ pub fn generate(
             .arg("-g")
             .arg("rust")
             .arg("-s")
-            .arg(&entry.path())
+            .arg(entry.path())
             .arg("-O")
             .arg(&result)
             .spawn()
@@ -184,7 +184,7 @@ pub enum GeneratorError {
 }
 
 impl std::fmt::Display for GeneratorError {
-    fn fmt(self: &Self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
         match self {
             GeneratorError::PythonError(err) => {
                 writeln!(f, "{} could not be executed", err)?;

flatdata-rs/lib/src/memstorage.rs

@@ -138,7 +138,7 @@ impl ResourceStorage for MemoryResourceStorage {
         // We cannot prove to Rust that the buffer will live as long as the storage
         // (we never delete mappings), so we need to manually extend lifetime
         let extended_lifetime_data = unsafe { slice::from_raw_parts(data.as_ptr(), data.len()) };
-        Ok(&extended_lifetime_data)
+        Ok(extended_lifetime_data)
     }
 
     fn create_output_stream(&self, resource_name: &str) -> Result<Box<dyn Stream>, io::Error> {

flatdata-rs/lib/src/multiarrayview.rs

@@ -102,7 +102,7 @@ where
         if !self.data.is_empty() {
             let type_index = self.data[0];
             self.data = &self.data[1..];
-            let res = <Ts as VariadicStruct>::create(type_index, &self.data);
+            let res = <Ts as VariadicStruct>::create(type_index, self.data);
             self.data = &self.data[res.size_in_bytes()..];
             Some(res)
         } else {

flatdata-rs/lib/src/rawdata.rs

@@ -44,6 +44,9 @@ impl<'a> RawData<'a> {
 
     /// Reads a \0 terminated substring starting at specified offset without checking that the
     /// string contains valid UTF-8.
+    ///
+    /// # Safety
+    /// Same as str::from_utf8_unchecked
     #[inline]
     pub unsafe fn substring_unchecked(&self, start: usize) -> &'a str {
         self.substring_with(start, |bytes| str::from_utf8_unchecked(bytes))

flatdata-rs/lib/src/structs.rs

@@ -52,6 +52,11 @@ pub trait Struct: Debug {
 }
 
 /// Marks structs that can be used stand-alone, e.g. no range
+///
+/// # Safety
+///
+/// Safe only if the struct does not any memory outside of its own memory range
+/// E.g. @range annotations use the next struct's memory and must not implement this
 pub unsafe trait NoOverlap {}
 /// Marks structs that cannot be used stand-alone, e.g. no range
 pub trait Overlap {}

flatdata-rs/lib/src/vector.rs

@@ -296,7 +296,7 @@ where
     fn flush(&mut self) -> io::Result<()> {
         self.resource_handle
             .borrow_mut()
-            .write(&self.data.as_view().as_bytes())?;
+            .write(self.data.as_view().as_bytes())?;
         self.data.clear();
         Ok(())
     }