Rename FileSerializationSink to just SerializationSink, now that there is a single kind.

Author: michaelwoerister

analyzeme/benches/serialization_bench.rs

@@ -5,15 +5,15 @@ extern crate test;
 use analyzeme::testing_common;
 
 #[bench]
-fn bench_file_serialization_sink(bencher: &mut test::Bencher) {
+fn bench_serialization_sink(bencher: &mut test::Bencher) {
     bencher.iter(|| {
-        testing_common::run_serialization_bench("file_serialization_sink_test", 500_000, 1);
+        testing_common::run_serialization_bench("serialization_sink_test", 500_000, 1);
     });
 }
 
 #[bench]
-fn bench_file_serialization_sink_8_threads(bencher: &mut test::Bencher) {
+fn bench_serialization_sink_8_threads(bencher: &mut test::Bencher) {
     bencher.iter(|| {
-        testing_common::run_serialization_bench("file_serialization_sink_test", 50_000, 8);
+        testing_common::run_serialization_bench("serialization_sink_test_8_threads", 50_000, 8);
     });
 }

analyzeme/src/profiling_data.rs

@@ -6,7 +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, StringTableBuilder};
+use measureme::{EventId, ProfilerFiles, RawEvent, SerializationSink, StringTableBuilder};
 use serde::{Deserialize, Deserializer};
 use std::error::Error;
 use std::fs;
@@ -199,17 +199,17 @@ impl<'a> DoubleEndedIterator for ProfilerEventIterator<'a> {
 /// implementation might not be efficient, which why it should only be used for
 /// writing tests and other things that are not performance sensitive.
 pub struct ProfilingDataBuilder {
-    event_sink: FileSerializationSink,
-    string_table_data_sink: Arc<FileSerializationSink>,
-    string_table_index_sink: Arc<FileSerializationSink>,
+    event_sink: SerializationSink,
+    string_table_data_sink: Arc<SerializationSink>,
+    string_table_index_sink: Arc<SerializationSink>,
     string_table: StringTableBuilder,
 }
 
 impl ProfilingDataBuilder {
     pub fn new() -> ProfilingDataBuilder {
-        let event_sink = FileSerializationSink::new_in_memory();
-        let string_table_data_sink = Arc::new(FileSerializationSink::new_in_memory());
-        let string_table_index_sink = Arc::new(FileSerializationSink::new_in_memory());
+        let event_sink = SerializationSink::new_in_memory();
+        let string_table_data_sink = Arc::new(SerializationSink::new_in_memory());
+        let string_table_index_sink = Arc::new(SerializationSink::new_in_memory());
 
         // The first thing in every file we generate must be the file header.
         write_file_header(&event_sink, FILE_MAGIC_EVENT_STREAM);

analyzeme/src/stringtable.rs

@@ -243,13 +243,13 @@ impl StringTable {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use measureme::{FileSerializationSink, StringComponent, StringTableBuilder};
+    use measureme::{SerializationSink, StringComponent, StringTableBuilder};
     use std::sync::Arc;
 
     #[test]
     fn simple_strings() {
-        let data_sink = Arc::new(FileSerializationSink::new_in_memory());
-        let index_sink = Arc::new(FileSerializationSink::new_in_memory());
+        let data_sink = Arc::new(SerializationSink::new_in_memory());
+        let index_sink = Arc::new(SerializationSink::new_in_memory());
 
         let expected_strings = &[
             "abc",
@@ -289,8 +289,8 @@ mod tests {
 
     #[test]
     fn composite_string() {
-        let data_sink = Arc::new(FileSerializationSink::new_in_memory());
-        let index_sink = Arc::new(FileSerializationSink::new_in_memory());
+        let data_sink = Arc::new(SerializationSink::new_in_memory());
+        let index_sink = Arc::new(SerializationSink::new_in_memory());
 
         let expected_strings = &[
             "abc",                  // 0

analyzeme/tests/serialization.rs

@@ -1,11 +1,11 @@
 use analyzeme::testing_common::run_end_to_end_serialization_test;
 
 #[test]
-fn test_file_serialization_sink_1_thread() {
-    run_end_to_end_serialization_test("file_serialization_sink_test_1_thread", 1);
+fn test_serialization_sink_1_thread() {
+    run_end_to_end_serialization_test("serialization_sink_test_1_thread", 1);
 }
 
 #[test]
-fn test_file_serialization_sink_8_threads() {
-    run_end_to_end_serialization_test("file_serialization_sink_test_8_threads", 8);
+fn test_serialization_sink_8_threads() {
+    run_end_to_end_serialization_test("serialization_sink_test_8_threads", 8);
 }

measureme/src/file_header.rs

@@ -1,7 +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::FileSerializationSink;
+use crate::SerializationSink;
 use std::convert::TryInto;
 use std::error::Error;
 
@@ -14,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: &FileSerializationSink, file_magic: &[u8; 4]) {
+pub fn write_file_header(s: &SerializationSink, 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);
@@ -53,11 +53,11 @@ pub fn strip_file_header(data: &[u8]) -> &[u8] {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::file_serialization_sink::FileSerializationSink;
+    use crate::SerializationSink;
 
     #[test]
     fn roundtrip() {
-        let data_sink = FileSerializationSink::new_in_memory();
+        let data_sink = SerializationSink::new_in_memory();
 
         write_file_header(&data_sink, FILE_MAGIC_EVENT_STREAM);
 
@@ -71,7 +71,7 @@ mod tests {
 
     #[test]
     fn invalid_magic() {
-        let data_sink = FileSerializationSink::new_in_memory();
+        let data_sink = SerializationSink::new_in_memory();
         write_file_header(&data_sink, FILE_MAGIC_STRINGTABLE_DATA);
         let mut data = data_sink.into_bytes();
 
@@ -82,7 +82,7 @@ mod tests {
 
     #[test]
     fn other_version() {
-        let data_sink = FileSerializationSink::new_in_memory();
+        let data_sink = SerializationSink::new_in_memory();
 
         write_file_header(&data_sink, FILE_MAGIC_STRINGTABLE_INDEX);
 

measureme/src/file_serialization_sink.rs

@@ -40,9 +40,6 @@
 
 pub mod event_id;
 pub mod file_header;
-#[cfg(any(not(target_arch = "wasm32"), target_os = "wasi"))]
-mod file_serialization_sink;
-#[cfg(not(target_arch = "wasm32"))]
 mod profiler;
 mod raw_event;
 mod serialization;
@@ -51,10 +48,7 @@ pub mod stringtable;
 pub mod rustc;
 
 pub use crate::event_id::{EventId, EventIdBuilder};
-#[cfg(any(not(target_arch = "wasm32"), target_os = "wasi"))]
-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;
+pub use crate::serialization::{Addr, SerializationSink};
 pub use crate::stringtable::{SerializableString, StringComponent, StringId, StringTableBuilder};

measureme/src/lib.rs

@@ -1,7 +1,7 @@
 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};
@@ -25,22 +25,22 @@ impl ProfilerFiles {
 }
 
 pub struct Profiler {
-    event_sink: Arc<FileSerializationSink>,
+    event_sink: Arc<SerializationSink>,
     string_table: StringTableBuilder,
     start_time: Instant,
 }
 
 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(FileSerializationSink::from_path(&paths.events_file)?);
+        let event_sink = Arc::new(SerializationSink::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(FileSerializationSink::from_path(&paths.string_data_file)?),
-            Arc::new(FileSerializationSink::from_path(&paths.string_index_file)?),
+            Arc::new(SerializationSink::from_path(&paths.string_data_file)?),
+            Arc::new(SerializationSink::from_path(&paths.string_index_file)?),
         );
 
         let profiler = Profiler {