Rename Write to WriteLogEvent

ir/serder_test.go

@@ -47,7 +47,7 @@ func testSerDerLogMessages(
 	irView := irSerializer.SerializeUtcOffsetChange(utcOffsetToronto)
 	_, err := ioWriter.Write(irView)
 	if nil != err {
-		t.Fatalf("io.Writer.Write message: %v", err)
+		t.Fatalf("io.Writer.WriteLogEvent message: %v", err)
 	}
 
 	var events []ffi.LogEvent
@@ -62,14 +62,14 @@ func testSerDerLogMessages(
 		}
 		_, err = ioWriter.Write(irView)
 		if nil != err {
-			t.Fatalf("io.Writer.Write message: %v", err)
+			t.Fatalf("io.Writer.WriteLogEvent message: %v", err)
 		}
 		events = append(events, event)
 	}
 	irSerializer.Close()
 	_, err = ioWriter.Write([]byte{0x0})
 	if nil != err {
-		t.Fatalf("io.Writer.Write message: %v", err)
+		t.Fatalf("io.Writer.WriteLogEvent message: %v", err)
 	}
 	ioWriter.Close()
 
@@ -116,7 +116,7 @@ func serializeIrPreamble(
 		t.Fatalf("short write for preamble: %v/%v", n, len(preambleIr))
 	}
 	if nil != err {
-		t.Fatalf("io.Writer.Write preamble: %v", err)
+		t.Fatalf("io.Writer.WriteLogEvent preamble: %v", err)
 	}
 	return serializer
 }

ir/writer.go

@@ -84,7 +84,7 @@ func (writer *Writer) CloseTo(w io.Writer) (int64, error) {
 
 // Bytes returns a slice of the Writer's internal buffer. The slice is valid for
 // use only until the next buffer modification (that is, only until the next
-// call to Write, WriteTo, or Reset).
+// call to WriteLogEvent, WriteTo, or Reset).
 func (writer *Writer) Bytes() []byte {
 	return writer.buf.Bytes()
 }
@@ -95,19 +95,20 @@ func (writer *Writer) Reset() {
 	writer.buf.Reset()
 }
 
-// Write uses [SerializeLogEvent] to serialize the provided log event to CLP IR
-// and then stores it in the internal buffer. Returns:
+// WriteLogEvent uses [SerializeLogEvent] to serialize the provided log event to CLP IR and then
+// stores it in the internal buffer. Returns:
 //   - success: number of bytes written, nil
-//   - error: number of bytes written (can be 0), error propagated from
-//     [SerializeLogEvent] or [bytes.Buffer.Write]
-func (writer *Writer) Write(event ffi.LogEvent) (int, error) {
+//   - error: number of bytes written (can be 0), error propagated from [SerializeLogEvent] or
+//     [bytes.Buffer.Write]
+func (writer *Writer) WriteLogEvent(event ffi.LogEvent) (int, error) {
 	irView, err := writer.SerializeLogEvent(event)
 	if nil != err {
 		return 0, err
 	}
-	// bytes.Buffer.Write will always return nil for err (https://pkg.go.dev/bytes#Buffer.Write)
+	// bytes.Buffer.WriteLogEvent will always return nil for err. Ref:
+	// (https://pkg.go.dev/bytes#Buffer.Write)
 	// However, err is still propagated to correctly alert the user in case this ever changes. If
-	// Write can fail in the future, we should either:
+	// WriteLogEvent can fail in the future, we should either:
 	//   1. fix the issue and retry the write
 	//   2. store irView and provide a retry API (allowing the user to fix the issue and retry)
 	n, err := writer.buf.Write(irView)

ir/writeread_test.go

@@ -42,9 +42,9 @@ func testWriteReadLogMessages(
 			LogMessage: msg,
 			Timestamp:  ffi.EpochTimeMs(time.Now().UnixMilli()),
 		}
-		_, err := irWriter.Write(event)
+		_, err := irWriter.WriteLogEvent(event)
 		if nil != err {
-			t.Fatalf("ir.Writer.Write failed: %v", err)
+			t.Fatalf("ir.Writer.WriteLogEvent failed: %v", err)
 		}
 		events = append(events, event)
 	}