feat!: API change to allow (in the future) stream writing of trace files

runtime_tracing/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "runtime_tracing"
-version = "0.12.2"
+version = "0.13.0"
 edition = "2021"
 authors = ["Metacraft Labs Ltd"]
 description = "A library for the schema and tracing helpers for the CodeTracer db trace format"

runtime_tracing/build.rs

@@ -1,6 +1,3 @@
 fn main() {
-    ::capnpc::CompilerCommand::new()
-        .file("src/trace.capnp")
-        .run()
-        .expect("compiling schema")
+    ::capnpc::CompilerCommand::new().file("src/trace.capnp").run().expect("compiling schema")
 }

runtime_tracing/src/base64.rs

@@ -9,5 +9,7 @@ pub fn serialize<S: Serializer>(v: &Vec<u8>, s: S) -> Result<S::Ok, S::Error> {
 
 pub fn deserialize<'de, D: Deserializer<'de>>(d: D) -> Result<Vec<u8>, D::Error> {
     let base64 = String::deserialize(d)?;
-    base64::engine::general_purpose::STANDARD.decode(base64.as_bytes()).map_err(serde::de::Error::custom)
+    base64::engine::general_purpose::STANDARD
+        .decode(base64.as_bytes())
+        .map_err(serde::de::Error::custom)
 }

runtime_tracing/src/lib.rs

@@ -8,11 +8,13 @@
 //! This crate provides the [`Tracer`] type for emitting trace events and a
 //! collection of serializable structures describing the trace format.
 //! The format is documented in `docs/` and the README.
-mod tracer;
-mod types;
 mod base64;
 mod capnptrace;
-pub use crate::tracer::{Tracer, TraceEventsFileFormat, NONE_TYPE_ID, NONE_VALUE};
+mod tracer;
+mod types;
+pub use crate::tracer::{
+    create_trace_reader, create_trace_writer, NonStreamingTraceWriter, TraceEventsFileFormat, TraceReader, TraceWriter, NONE_TYPE_ID, NONE_VALUE,
+};
 pub use crate::types::*;
 
 pub mod trace_capnp {
@@ -27,7 +29,7 @@ mod tests {
 
     #[test]
     fn test_simple_trace() {
-        let mut tracer = Tracer::new("path.small", &vec![]);
+        let mut tracer = NonStreamingTraceWriter::new("path.small", &vec![]);
         let path = Path::new("/test/path.small");
         tracer.start(path, Line(1));
         tracer.register_step(path, Line(1));