Skip to content

Commit d58b59d

Browse files
committed
add missing doc comments
1 parent 1056d1f commit d58b59d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

capnp/src/serialize.rs

+5-1
Original file line numberDiff line numberDiff line change
@@ -276,13 +276,15 @@ where R: Read {
276276
Ok(crate::message::Reader::new(owned_segments, options))
277277
}
278278

279-
/// Constructs a flat vector containing the entire message.
279+
/// Constructs a flat vector containing the entire message, including a segment header.
280280
pub fn write_message_to_words<A>(message: &message::Builder<A>) -> Vec<u8>
281281
where A: message::Allocator
282282
{
283283
flatten_segments(&*message.get_segments_for_output())
284284
}
285285

286+
/// Like `write_message_to_words()`, but takes a `ReaderSegments`, allowing it to be
287+
/// used on `message::Reader` objects (via `into_segments()`).
286288
pub fn write_message_segments_to_words<R>(message: &R) -> Vec<u8>
287289
where R: message::ReaderSegments
288290
{
@@ -321,6 +323,8 @@ pub fn write_message<W, A>(mut write: W, message: &message::Builder<A>) -> Resul
321323
write_segments(&mut write, &segments)
322324
}
323325

326+
/// Like `write_message()`, but takes a `ReaderSegments`, allowing it to be
327+
/// used on `message::Reader` objects (via `into_segments()`).
324328
pub fn write_message_segments<W, R>(mut write: W, segments: &R) -> Result<()>
325329
where W: Write, R: message::ReaderSegments {
326330
write_segment_table_internal(&mut write, segments)?;

0 commit comments

Comments
 (0)