Note that certain NIOFileHandle.init overloads are blocking (apple#1630)

MaxDesiatov · web-flow · commit 96db8838be60 · 2020-09-07T10:48:15.000+01:00
This was noted in review of swift-server/async-http-client#275, but I don't think that this was clearly stated in the documentation.
diff --git a/Sources/NIO/FileHandle.swift b/Sources/NIO/FileHandle.swift
@@ -134,7 +134,7 @@ extension NIOFileHandle {
         }
     }
 
-    /// Open a new `NIOFileHandle`.
+    /// Open a new `NIOFileHandle`. This operation is blocking.
     ///
     /// - parameters:
     ///     - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.
@@ -145,7 +145,7 @@ extension NIOFileHandle {
         self.init(descriptor: fd)
     }
 
-    /// Open a new `NIOFileHandle`.
+    /// Open a new `NIOFileHandle`. This operation is blocking.
     ///
     /// - parameters:
     ///     - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ extension NIOFileHandle {`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`
`137`		- /// Open a new `NIOFileHandle`.
	`137`	+ /// Open a new `NIOFileHandle`. This operation is blocking.
`138`	`138`	`///`
`139`	`139`	`/// - parameters:`
`140`	`140`	/// - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.
`@@ -145,7 +145,7 @@ extension NIOFileHandle {`
`145`	`145`	`self.init(descriptor: fd)`
`146`	`146`	`}`
`147`	`147`
`148`		- /// Open a new `NIOFileHandle`.
	`148`	+ /// Open a new `NIOFileHandle`. This operation is blocking.
`149`	`149`	`///`
`150`	`150`	`/// - parameters:`
`151`	`151`	/// - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.