martin-g commented on code in PR #193:
URL: https://github.com/apache/avro-rs/pull/193#discussion_r2070704449
##########
avro/src/writer.rs:
##########
@@ -658,6 +656,19 @@ pub fn to_avro_datum<T: Into<Value>>(schema: &Schema,
value: T) -> AvroResult<Ve
Ok(buffer)
}
+/// Write the referenced `Serialize` object to the provided Write object.
Returns a result with
Review Comment:
```suggestion
/// Write the referenced `Serialize` object to the provided `Write` object.
Returns a result with
```
##########
avro/src/writer.rs:
##########
@@ -658,6 +656,19 @@ pub fn to_avro_datum<T: Into<Value>>(schema: &Schema,
value: T) -> AvroResult<Ve
Ok(buffer)
}
+/// Write the referenced `Serialize` object to the provided Write object.
Returns a result with
+/// the number of bytes written.
+///
+/// **NOTE** This function has a quite small niche of usage and does NOT
generate headers and sync
+/// markers; use [`Writer`](struct.Writer.html) to be fully Avro-compatible if
you don't know what
Review Comment:
> use [`Writer`](struct.Writer.html) to be fully Avro-compatible if you
don't know what
I don't quite follow you here. What do you mean by `use Writer instead` ?
IMO it would be clearer to say something like `use write_ref(...) instead`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
