Skip to content

Commit fabb30c

Browse files
committed
Try and word this a little better
1 parent 629e687 commit fabb30c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

quinn/src/connection.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,10 @@ impl Connection {
396396
/// path opens. The [`PathId`] for the events can be extracted from
397397
/// [`OpenPath::path_id`].
398398
///
399-
/// If opening fails either the future will be immediately ready, or another
400-
/// [`PathEvent`] for the [`PathId`] will be emitted, indicating the failure.
399+
/// Failure to open a path can either occur immediately, before polling the returned
400+
/// future, or at a later time. If the failure is immediate [`OpenPath::path_id`] will
401+
/// return `None` and the future will be ready immediately. If the failure happens
402+
/// later, a [`PathEvent`] will be emitted.
401403
pub fn open_path(&self, addr: SocketAddr, initial_status: PathStatus) -> OpenPath {
402404
let mut state = self.0.state.lock("open_path");
403405
let (on_open_path_send, on_open_path_recv) = watch::channel(Ok(()));

0 commit comments

Comments
 (0)