Skip to content

Commit bcf3f73

Browse files
committed
clarify doc comment for capnp_futures::serialize::try_read_message()
1 parent 790d339 commit bcf3f73

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

capnp-futures/src/serialize.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ pub async fn read_message<R>(reader: R, options: message::ReaderOptions) -> Resu
3636
}
3737

3838

39-
/// Begins an asynchronous read of a message from `reader`. Returns `None` if
40-
/// `reader` has zero bytes left (i.e. is at end-of-file). To read a stream
39+
/// Asynchronously reads a message from `reader`. Returns `None` if `reader`
40+
/// has zero bytes left (i.e. is at end-of-file). To read a stream
4141
/// containing an unknown number of messages, you could call this function
4242
/// repeatedly until it returns `None`.
4343
pub async fn try_read_message<R>(mut reader: R, options: message::ReaderOptions) -> Result<Option<message::Reader<OwnedSegments>>>

0 commit comments

Comments
 (0)