Remove the SerializationSink trait.

Author: michaelwoerister

analyzeme/src/profiling_data.rs

@@ -6,9 +6,7 @@ use measureme::file_header::{
     read_file_header, write_file_header, CURRENT_FILE_FORMAT_VERSION, FILE_HEADER_SIZE,
     FILE_MAGIC_EVENT_STREAM,
 };
-use measureme::{
-    EventId, FileSerializationSink, ProfilerFiles, RawEvent, SerializationSink, StringTableBuilder,
-};
+use measureme::{EventId, FileSerializationSink, ProfilerFiles, RawEvent, StringTableBuilder};
 use serde::{Deserialize, Deserializer};
 use std::error::Error;
 use std::fs;

measureme/src/file_header.rs

@@ -1,8 +1,7 @@
 //! All binary files generated by measureme have a simple file header that
 //! consists of a 4 byte file magic string and a 4 byte little-endian version
 //! number.
-
-use crate::serialization::SerializationSink;
+use crate::FileSerializationSink;
 use std::convert::TryInto;
 use std::error::Error;
 
@@ -15,7 +14,7 @@ pub const FILE_MAGIC_STRINGTABLE_INDEX: &[u8; 4] = b"MMSI";
 /// rely on this size to be `8`.
 pub const FILE_HEADER_SIZE: usize = 8;
 
-pub fn write_file_header<S: SerializationSink>(s: &S, file_magic: &[u8; 4]) {
+pub fn write_file_header(s: &FileSerializationSink, file_magic: &[u8; 4]) {
     // The implementation here relies on FILE_HEADER_SIZE to have the value 8.
     // Let's make sure this assumption cannot be violated without being noticed.
     assert_eq!(FILE_HEADER_SIZE, 8);

measureme/src/file_serialization_sink.rs

@@ -1,4 +1,4 @@
-use crate::serialization::{Addr, SerializationSink};
+use crate::serialization::Addr;
 use parking_lot::Mutex;
 use std::error::Error;
 use std::fmt::Debug;
@@ -69,10 +69,8 @@ impl FileSerializationSink {
         // Then we can create a copy of the data written so far.
         file.drain_bytes()
     }
-}
 
-impl SerializationSink for FileSerializationSink {
-    fn from_path(path: &Path) -> Result<Self, Box<dyn Error + Send + Sync>> {
+    pub fn from_path(path: &Path) -> Result<Self, Box<dyn Error + Send + Sync>> {
         fs::create_dir_all(path.parent().unwrap())?;
 
         let file = fs::File::create(path)?;
@@ -88,7 +86,7 @@ impl SerializationSink for FileSerializationSink {
     }
 
     #[inline]
-    fn write_atomic<W>(&self, num_bytes: usize, write: W) -> Addr
+    pub fn write_atomic<W>(&self, num_bytes: usize, write: W) -> Addr
     where
         W: FnOnce(&mut [u8]),
     {
@@ -131,7 +129,7 @@ impl SerializationSink for FileSerializationSink {
         Addr(curr_addr)
     }
 
-    fn write_bytes_atomic(&self, bytes: &[u8]) -> Addr {
+    pub fn write_bytes_atomic(&self, bytes: &[u8]) -> Addr {
         if bytes.len() < 128 {
             // For "small" pieces of data, use the regular implementation so we
             // don't repeatedly flush an almost empty buffer to disk.

measureme/src/lib.rs

@@ -56,5 +56,5 @@ pub use crate::file_serialization_sink::FileSerializationSink;
 #[cfg(not(target_arch = "wasm32"))]
 pub use crate::profiler::{Profiler, ProfilerFiles, TimingGuard};
 pub use crate::raw_event::{RawEvent, MAX_INSTANT_TIMESTAMP, MAX_INTERVAL_TIMESTAMP};
-pub use crate::serialization::{Addr, SerializationSink};
+pub use crate::serialization::Addr;
 pub use crate::stringtable::{SerializableString, StringComponent, StringId, StringTableBuilder};

measureme/src/profiler.rs

@@ -2,7 +2,6 @@ use crate::event_id::EventId;
 use crate::file_header::{write_file_header, FILE_MAGIC_EVENT_STREAM};
 use crate::file_serialization_sink::FileSerializationSink;
 use crate::raw_event::RawEvent;
-use crate::serialization::SerializationSink;
 use crate::stringtable::{SerializableString, StringId, StringTableBuilder};
 use std::error::Error;
 use std::path::{Path, PathBuf};
@@ -34,14 +33,14 @@ pub struct Profiler {
 impl Profiler {
     pub fn new<P: AsRef<Path>>(path_stem: P) -> Result<Profiler, Box<dyn Error + Send + Sync>> {
         let paths = ProfilerFiles::new(path_stem.as_ref());
-        let event_sink = Arc::new(SerializationSink::from_path(&paths.events_file)?);
+        let event_sink = Arc::new(FileSerializationSink::from_path(&paths.events_file)?);
 
         // The first thing in every file we generate must be the file header.
         write_file_header(&*event_sink, FILE_MAGIC_EVENT_STREAM);
 
         let string_table = StringTableBuilder::new(
-            Arc::new(SerializationSink::from_path(&paths.string_data_file)?),
-            Arc::new(SerializationSink::from_path(&paths.string_index_file)?),
+            Arc::new(FileSerializationSink::from_path(&paths.string_data_file)?),
+            Arc::new(FileSerializationSink::from_path(&paths.string_index_file)?),
         );
 
         let profiler = Profiler {
@@ -167,3 +166,9 @@ impl<'a> TimingGuard<'a> {
         drop(self)
     }
 }
+
+// Make sure that `Profiler` can be used in a multithreaded context
+fn _assert_bounds() {
+    assert_bounds_inner(&Profiler::new(""));
+    fn assert_bounds_inner<S: Sized + Send + Sync + 'static>(_: &S) {}
+}

measureme/src/serialization.rs

@@ -1,6 +1,3 @@
-use std::error::Error;
-use std::path::Path;
-
 #[derive(Clone, Copy, Eq, PartialEq, Debug)]
 pub struct Addr(pub u32);
 
@@ -9,25 +6,3 @@ impl Addr {
         self.0 as usize
     }
 }
-
-pub trait SerializationSink: Sized + Send + Sync + 'static {
-    fn from_path(path: &Path) -> Result<Self, Box<dyn Error + Send + Sync>>;
-
-    /// Atomically write `num_bytes` to the sink. The implementation must ensure
-    /// that concurrent invocations of `write_atomic` do not conflict with each
-    /// other.
-    ///
-    /// The `write` argument is a function that must fill the output buffer
-    /// passed to it. The output buffer is guaranteed to be exactly `num_bytes`
-    /// large.
-    fn write_atomic<W>(&self, num_bytes: usize, write: W) -> Addr
-    where
-        W: FnOnce(&mut [u8]);
-
-    /// Same as write_atomic() but might be faster in cases where bytes to be
-    /// written are already present in a buffer (as opposed to when it is
-    /// benefical to directly serialize into the output buffer).
-    fn write_bytes_atomic(&self, bytes: &[u8]) -> Addr {
-        self.write_atomic(bytes.len(), |sink| sink.copy_from_slice(bytes))
-    }
-}

measureme/src/stringtable.rs

@@ -67,7 +67,7 @@ use crate::file_header::{
     write_file_header, FILE_MAGIC_STRINGTABLE_DATA, FILE_MAGIC_STRINGTABLE_INDEX,
 };
 use crate::file_serialization_sink::FileSerializationSink;
-use crate::serialization::{Addr, SerializationSink};
+use crate::serialization::Addr;
 use std::sync::Arc;
 
 /// A `StringId` is used to identify a string in the `StringTable`. It is