Skip to content

Commit 3d4b78d

Browse files
committed
mention buffering in doc comment for VatNetwork::new()
1 parent 9a8b227 commit 3d4b78d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

capnp-rpc/src/twoparty.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,8 @@ where
215215
T: AsyncRead + Unpin,
216216
{
217217
/// Creates a new two-party vat network that will receive data on `input_stream` and send data on
218-
/// `output_stream`.
218+
/// `output_stream`. (Typically, performance is best if these streams are buffered, possibly via
219+
/// `futures::io::BufReader` and `futures::io::BufWriter`.)
219220
///
220221
/// `side` indicates whether this is the client or the server side of the connection. This has no
221222
/// effect on the data sent over the connection; it merely exists so that `RpcNetwork::bootstrap` knows

0 commit comments

Comments
 (0)