Tweak docs of StreamMuxer::poll_event

This commit is contained in:
Roman S. Borschel
2020-11-24 17:36:44 +01:00
parent e3af8b7d03
commit 86d2281222

View File

@ -91,6 +91,9 @@ pub trait StreamMuxer {
/// is ready to be polled, similar to the API of `Stream::poll()`.
/// Only the latest task that was used to call this method may be notified.
///
/// It is permissible and common to use this method to perform background
/// work, such as processing incoming packets and polling timers.
///
/// An error can be generated if the connection has been closed.
fn poll_event(&self, cx: &mut Context<'_>) -> Poll<Result<StreamMuxerEvent<Self::Substream>, Self::Error>>;